From c2d283b7c39bab982b17fa585e6760506de2c212 Mon Sep 17 00:00:00 2001 From: Nikos Alexandris Date: Mon, 28 Jun 2021 14:56:55 +0300 Subject: [PATCH 1/8] Re-title the README.md, add link to addons overview manual page --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4506932764..113843b3da 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# GRASS Addons git repository +# GRASS GIS Addons + +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. ## How to get write access here From 065df7079d6fe33b34cee073d1548b8044f67b0c Mon Sep 17 00:00:00 2001 From: Nikos Alexandris Date: Mon, 28 Jun 2021 15:06:24 +0300 Subject: [PATCH 2/8] Move install instructions in separate sub-section --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 113843b3da..bb641d5803 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ # GRASS GIS Addons -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. +This is the official GRASS GIS Addons git repository. +Head over to [GRASS GIS 7Addons Manual +pages](https://grass.osgeo.org/grass78/manuals/addons/) +for an overview. +## Install AddOns ## How to get write access here +The simplest way to install GRASS GIS AddOns is to use the `g.extension` +module which is part of any GRASS GIS installation: 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). +The same module can remove installed addons In either case, please read the submitting rules at the bottom of this page. ## How to get the AddOn code @@ -26,9 +32,6 @@ git clone https://github.com/OSGeo/grass-addons.git grass_addons ## How to install or remove AddOns in your GRASS installation -The simplest way to install GRASS GIS AddOns is to use the `g.extension` -module: - ## How to compile AddOn code From e7d01ed9dcd8107b74ddb36d8ba93d753c54e88e Mon Sep 17 00:00:00 2001 From: Nikos Alexandris Date: Mon, 28 Jun 2021 15:08:32 +0300 Subject: [PATCH 3/8] Re-section the README.md, shorten sub-section titles --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bb641d5803..29c0fcceef 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,9 @@ a [pull request](https://help.github.com/en/articles/about-pull-requests). The same module can remove installed addons In either case, please read the submitting rules at the bottom of this page. -## How to get the AddOn code +## This repository + +### Clone locally Clone of the entire AddOns git repository: @@ -30,12 +32,12 @@ 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 -## 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 @@ -69,7 +71,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: @@ -78,7 +80,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 From cd2db005a612085fd254d311eca8bb86d4695e75 Mon Sep 17 00:00:00 2001 From: Nikos Alexandris Date: Mon, 28 Jun 2021 15:09:16 +0300 Subject: [PATCH 4/8] Move 'write access' related content under ### Write access --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 29c0fcceef..1766411da4 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,13 @@ pages](https://grass.osgeo.org/grass78/manuals/addons/) for an overview. ## Install AddOns -## How to get write access here The simplest way to install GRASS GIS AddOns is to use the `g.extension` module which is part of any GRASS GIS installation: -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). The same module can remove installed addons -In either case, please read the submitting rules at the bottom of this page. ## This repository @@ -34,6 +26,15 @@ git clone https://github.com/OSGeo/grass-addons.git grass_addons ### Write access +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. ### Compile AddOns From 50b9581fd28c6798c0aa764dc2378eb2bcc80702 Mon Sep 17 00:00:00 2001 From: Nikos Alexandris <7046639+NikosAlexandris@users.noreply.github.com> Date: Mon, 28 Jun 2021 17:52:48 +0200 Subject: [PATCH 5/8] Update README.md Co-authored-by: Veronica Andreo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1766411da4..dbb65039fb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # GRASS GIS Addons This is the official GRASS GIS Addons git repository. -Head over to [GRASS GIS 7Addons Manual +Head over to [GRASS GIS 7 Addons Manual pages](https://grass.osgeo.org/grass78/manuals/addons/) for an overview. From 34728dd7453f8bf8ce83889bf95f4cc74649d12f Mon Sep 17 00:00:00 2001 From: Nikos Alexandris <7046639+NikosAlexandris@users.noreply.github.com> Date: Mon, 28 Jun 2021 17:53:08 +0200 Subject: [PATCH 6/8] Update README.md Co-authored-by: Veronica Andreo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dbb65039fb..f6f453fa6c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ for an overview. ## Install AddOns -The simplest way to install GRASS GIS AddOns is to use the `g.extension` +The simplest way to install GRASS GIS Addons is to use the `g.extension` module which is part of any GRASS GIS installation: From 8ec83597d13e5df6611d8ff4a561c70fa9736ece Mon Sep 17 00:00:00 2001 From: Nikos Alexandris <7046639+NikosAlexandris@users.noreply.github.com> Date: Mon, 28 Jun 2021 17:53:20 +0200 Subject: [PATCH 7/8] Update README.md Co-authored-by: Veronica Andreo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f6f453fa6c..fd27824108 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ module which is part of any GRASS GIS installation: -The same module can remove installed addons +The same module can also remove installed addons. ## This repository From 534860a702c6398a9726464318cd1c6043fe2bf2 Mon Sep 17 00:00:00 2001 From: Nikos Alexandris <7046639+NikosAlexandris@users.noreply.github.com> Date: Mon, 28 Jun 2021 17:53:35 +0200 Subject: [PATCH 8/8] Update README.md Co-authored-by: Veronica Andreo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd27824108..65f480f010 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ The same module can also remove installed addons. ### 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