Archives/awesome-cli-apps
2
0
Fork 0
mirror of https://github.com/toolleeo/cli-apps.git synced 2024-11-05 06:00:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Moved contribution instructions to footer

Browse Source
This commit is contained in:
Tullio Facchinetti 2023-10-19 21:57:53 +02:00
parent 373d4603e8
commit a5c4e20cc2
1 changed files with 43 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -6,31 +6,7 @@ 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).
# Summary
@ -1676,3 +1652,45 @@ A list of some online resoures that contribute interesting links to apps and inf
# <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. :-)