Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: Tidy up INSTALL and REQUIREMENTS files #3499

Merged
merged 4 commits into from
Mar 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 6 additions & 43 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,9 @@ Please read _all_ text below.
- (H) COMPILING INDIVIDUAL MODULES - OWN MODULES
- (I) CODE OPTIMIZATION
- (J) DEBUGGING OPTIONS
- (K) LARGE FILE SUPPORT (for raster maps)
- (L) SUPPORT
- (M) GRASS GIS PROGRAMMER'S MANUAL
- (N) CONTRIBUTING CODE AND PATCHES
- (O) DRAFT TUTORIAL
- (K) SUPPORT
- (L) GRASS GIS PROGRAMMER'S MANUAL
- (M) CONTRIBUTING CODE AND PATCHES

## PREREQUISITES

Expand Down Expand Up @@ -56,7 +54,6 @@ repository (<https://github.com/OSGeo/grass/>) or as a auto-generated snapshot
contains the date when the snapshot was created (checked out from
the GitHub repository), e.g. grass-3.7.git_src_snapshot_2022_04_27.tar.gz
from <https://grass.osgeo.org/grass-devel/source/snapshot/>
Further instructions at <https://trac.osgeo.org/grass/wiki/DownloadSource>

## (B) COMPILATION

Expand Down Expand Up @@ -149,18 +146,6 @@ make
make install
```

To fully enable 64bit library usage for GRASS on 64bit platforms,
the following additional parameters are recommended/required:

```bash
./configure \
--enable-64bit \
--with-libs=/usr/lib64 \
...
```

See also CODE OPTIMIZATION below.

## (D) INSTALLATION (first time)

After compilation, the resulting code is stored in the directory
Expand Down Expand Up @@ -325,25 +310,7 @@ CFLAGS="-g -Wall" ./configure
See also the file ./doc/debugging.txt and the Wiki page
<https://grasswiki.osgeo.org/wiki/GRASS_Debugging>

## (K) LARGE FILE SUPPORT (for raster maps)

GRASS GIS includes improved support for reading and writing large files
(> 2GB) if it is possible in your operating system. If you compile with

```bash
configure [...] --enable-largefile
```

you should be able to have raster and vector maps which are larger than 2GB.

While most code has been updated, individual programs may not yet work with
large files - please report.

See also
<https://grasswiki.osgeo.org/wiki/GRASS_GIS_Performance>
<https://grasswiki.osgeo.org/wiki/Software_requirements_specification>

## (L) SUPPORT
## (K) SUPPORT

Note that this code is still actively being developed and errors inevitably
turn up. If you find a bug, please report it to the GRASS bug tracking system
Expand All @@ -352,21 +319,17 @@ so we can fix it. See <https://grass.osgeo.org/contribute/>
If you are interested in helping to develop GRASS, please join the GRASS
developers mailing list. See <https://grass.osgeo.org/development/>

## (M) GRASS PROGRAMMER'S MANUAL
## (L) GRASS PROGRAMMER'S MANUAL

The Programmer's manual is generated with doxygen from the source code.
Please see the README file and the files at:
<https://grass.osgeo.org/programming8/>

## (N) CONTRIBUTING CODE AND PATCHES
## (M) CONTRIBUTING CODE AND PATCHES

Please see ./SUBMITTING in this directory, or better,
<https://trac.osgeo.org/grass/wiki/Submitting>

## (O) TUTORIALS

<https://grass.osgeo.org/learn/newcomers/>

## Authors

Markus Neteler and the GRASS Development Team
4 changes: 4 additions & 0 deletions REQUIREMENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,15 @@ Note: also the respective development packages (commonly named `xxx-dev` or
[https://mesa3d.org/](https://mesa3d.org/)
- **libpng** (for `r.out.png` and the PNG driver), usually already installed.
[http://www.libpng.org/pub/png/libpng.html](http://www.libpng.org/pub/png/libpng.html)
- **LIBSVM** (for SVM classification modules `i.svm.train` and `i.svm.predict`)
[https://www.csie.ntu.edu.tw/~cjlin/libsvm/](https://www.csie.ntu.edu.tw/~cjlin/libsvm/)
- **libtiff** (for `r.out.tiff`), usually already installed.
[https://gitlab.com/libtiff/libtiff](https://gitlab.com/libtiff/libtiff)
- **readline** for extra command prompt functionality
[https://tiswww.case.edu/~chet/readline/rltop.html](https://tiswww.case.edu/~chet/readline/rltop.html)
[ftp://ftp.gnu.org/gnu/readline](ftp://ftp.gnu.org/gnu/readline)
- **PDAL** ( for LAS import modules `r.in.pdal` and `v.in.pdal`)
[https://pdal.io](https://pdal.io)
- **PostgreSQL libraries** (for the PostgreSQL database interface and PostGIS support)
[https://www.postgresql.org](https://www.postgresql.org)
- **MariaDB/MySQL libraries** (for the MySQL database interface)
Expand Down
Loading