diff --git a/README.md b/README.md index 4506932764..65f480f010 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,44 @@ -# GRASS Addons git repository +# GRASS GIS Addons -## How to get write access here +This is the official GRASS GIS Addons git repository. +Head over to [GRASS GIS 7 Addons Manual +pages](https://grass.osgeo.org/grass78/manuals/addons/) +for an overview. -Read access is granted to the public, write access -must be requested, see here for details: - +## Install AddOns -However, it is also possible to fork this repository, insert your AddOn or fix -an existing one in a new branch and finally open -a [pull request](https://help.github.com/en/articles/about-pull-requests). +The simplest way to install GRASS GIS Addons is to use the `g.extension` +module which is part of any GRASS GIS installation: -In either case, please read the submitting rules at the bottom of this page. + + +The same module can also remove installed addons. + +## This repository -## How to get the AddOn code +### Clone locally -Clone of the entire AddOns git repository: +Clone of the entire addons git repository: ``` git clone https://github.com/OSGeo/grass-addons.git grass_addons ``` -## How to install or remove AddOns in your GRASS installation +### Write access -The simplest way to install GRASS GIS AddOns is to use the `g.extension` -module: - +Read access is granted to the public, write access +must be requested, see here for details: + + +However, it is also possible to fork this repository, insert your AddOn or fix +an existing one in a new branch and finally open +a [pull request](https://help.github.com/en/articles/about-pull-requests). + +In either case, please read the submitting rules at the bottom of this page. -## How to compile AddOn code +### Compile AddOns -### C code/Scripts, with GRASS source code on your computer +#### With GRASS source code on your computer Preparations (assuming the source code in $HOME/grass78/): (if you have already built GRASS from source you don't need to do this @@ -62,7 +72,7 @@ make MODULE_TOPDIR=$HOME/grass78/ install For system-wide installation this usually requires "root" priviledges (so, also 'sudo' may help). -### C code/Scripts, with GRASS binaries on your computer +#### With GRASS binaries on your computer compile GRASS AddOns modules into your GRASS code by setting MODULE_TOPDIR to where to the GRASS binaries are located: @@ -71,7 +81,7 @@ MODULE_TOPDIR to where to the GRASS binaries are located: make MODULE_TOPDIR=/usr/lib/grass78/ ``` -## How to submit contributions +### Contribute To submit your GRASS GIS module here, please check