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.

Sign up for GitHub

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

Jump to bottom

Update Readme, add link to addons manual page #573

Open
wants to merge 8 commits into
base: grass8
Choose a base branch
from
Open

Update Readme, add link to addons manual page #573

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c2d283b
Re-title the README.md, add link to addons overview manual page
NikosAlexandris Jun 28, 2021
065df70
Move install instructions in separate sub-section
NikosAlexandris Jun 28, 2021
e7d01ed
Re-section the README.md, shorten sub-section titles
NikosAlexandris Jun 28, 2021
cd2db00
Move 'write access' related content under ### Write access
NikosAlexandris Jun 28, 2021
50b9581
Update README.md
NikosAlexandris Jun 28, 2021
34728dd
Update README.md
NikosAlexandris Jun 28, 2021
8ec8359
Update README.md
NikosAlexandris Jun 28, 2021
534860a
Update README.md
NikosAlexandris Jun 28, 2021
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
48 changes: 29 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,44 @@
# GRASS Addons git repository
# GRASS GIS Addons
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# GRASS GIS Addons
# GRASS GIS addons


## How to get write access here
This is the official GRASS GIS Addons git repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"git repository" sounds like there is some other one. Well, maybe there is (binaries for Windows), but is that relevant here? In any case, Git should be capitalized (the software uses first upper case when it is not the command line tool name).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This is the official GRASS GIS Addons git repository.
This is the official GRASS GIS addons repository.

Head over to [GRASS GIS 7 Addons Manual
pages](https://grass.osgeo.org/grass78/manuals/addons/)
Comment on lines +4 to +5
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Head over to [GRASS GIS 7 Addons Manual
pages](https://grass.osgeo.org/grass78/manuals/addons/)
Head over to [GRASS GIS 8 addons Manual
pages](https://grass.osgeo.org/grass80/manuals/addons/)

for an overview.

Read access is granted to the public, write access
must be requested, see here for details:
<https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository>
## Install AddOns
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Install AddOns
## 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`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:

In either case, please read the submitting rules at the bottom of this page.
<https://grass.osgeo.org/grass-stable/manuals/g.extension.html>

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about changing this to Contributing? Then, adding a paragraph like (compiled/adapted according to comments):

Contributing to GRASS GIS addons repository is really simple. Just fork the repo and make a pull request. We welcome fixes, enhancements and new addons.
If you would like to become a mantainer, you can request for write access. See here for details.
In either case, please read the submitting rules at the bottom of this page.


The simplest way to install GRASS GIS AddOns is to use the `g.extension`
module:
<https://grass.osgeo.org/grass-stable/manuals/g.extension.html>
Read access is granted to the public, write access
must be requested, see here for details:
<https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository>
Comment on lines +29 to +31
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really awkward given the current state of art. The fork & read the contributing file route should be the primary or only way mentioned. The write access, i.e., becoming sort of a co-maintainer, should be mentioned second or in the contributing file.


However, it is also possible to fork this repository, insert your AddOn or fix
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should decide how to write addons: AddOns, add-ons, addons, etc?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this ever decided elsewhere? For now, here it seems lowercase, one word, « addons » is used d’or talking about the repo, and « addon » for when talking for a single one.

Does this align with the user interface inside the software?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some more decision here #929

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
Expand Down Expand Up @@ -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:
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be changed to "Submiting guidelines" or so...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably stick to How to contribute or Contributing [guidelines] and leave out these pieces from the readme. GitHub calls it Contributing in Insights > Community and it is supposed to be centered around a CONTRIBUTING.md file which we already have.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you suggest then to remove this section from README.md completely, and move whatever is down here to CONTRIBUTING.md? If yes, it sounds reasonable to me. Moreover, the submitting link is also in SUBMITTING.md. So, we could just link to both files and done. I can create a new PR from scratch with all suggestions here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good.

Perhaps, you can remove SUBMITTING. The word for it now is contributing and we have CONTRIBUTING.md. Will anyone look for a file called SUBMITTING and ignore file called CONTRIBUTING.md? Or is there an automated system which uses that? Probably not.


To submit your GRASS GIS module here, please check

Expand Down