Moved contribution instructions to the footer

pull/29/head
Tullio Facchinetti 6 months ago
parent d13008274f
commit 373d4603e8

@ -1,5 +1,5 @@
README.md: data/header.md data/cli-apps.md
cat data/header.md data/cli-apps.md > README.md
README.md: data/header.md data/footer.md data/cli-apps.md
cat data/header.md data/cli-apps.md data/footer.md > README.md
data/cli-apps.md: cli2md.py data/apps.csv data/categories.csv data/resources.csv data/articles.csv
python3 cli2md.py > data/cli-apps.md

@ -0,0 +1,42 @@
# <a name="contribute"></a>How to contribute
If you have any suggestion or want your project included in the list, you can contribute in the following ways.
## Open an issue
To suggest a new program, check the existence of the program in the list.
If it is not present, you can open an issue including the following list:
- `name`: Name of the program
- `homepage`: URL of the homepage (if it exists)
- `git`: URL of a clonable git repository (if it exists)
- `description`: Text to the description of the program
One or both of the two item `homepage` or `git` must be present.
## Pull request on `data/apps.csv`
The peculiarity of this repository is that the source of information is structured into CSV files with a simple structure.
See the `data/` directory.
If you want to contribute using a pull request, add the new entry to `data/apps.csv`.
In the CSV file, the `git` field refers to a **clonable git URL**.
Please make changes **to the CSV file only**, **not to the README file**.
I will review the request and, upon acceptance, I will take care of generating the README and updating the list.
## Contribution via email
If you prefer an email, contact me at `toolleeo@gmail.com` by sending the same information required for the "open an issue" method.
# Generation of the README file
If necessary, this `README` file can be (re-)generated from the CSV files.
To build `README.md` run:
```
make
```
`python3` is required for building. And `make`, of course. :-)

@ -6,28 +6,4 @@ To the best of my knowledge, this is the largest collection of CLI/TUI tools ava
If you are looking for additional information, you may like [CLIpedia](https://robot.unipv.it/clipedia/), a growing blog about CLI/TUI programs.
# Data organization and building of the list
The peculiarity of this repository is that the source of information is structured into CSV files with a simple structure.
See the `data/` directory.
This `README` file is generated from the CSV files.
To build `README.md` run:
```
make
```
`python3` is required for building. And `make`, of course. :-)
# How to contribute
If you have any suggestion or want your project included in the list, you can either open a pull request or send me an email with the necessary information.
If you want to contribute through a pull request, make sure to add new entries to the correct CSV file under the `data/` directory.
In the CSV, the `git` field refers to a **clonable git URL**.
Please commit changes **to the CSV file only**, **not the README**.
I will review the request and, upon acceptance, I will take care of generating the README and updating the list.
If you prefer an email, contact me at `toolleeo@gmail.com`.
To contribute, see [this section](#contribute).

Loading…
Cancel
Save