Updated README

This commit is contained in:
zortazert 2022-03-31 15:06:44 -05:00
parent 8c8673e485
commit b12ec4d06e

View file

@ -7,10 +7,12 @@ A search tool for free software replacements.
In the [apps](apps) folder there are a bunch of json files for software. Here is an example:
- `names` what the software is called.
- `comment` description of the software.
- `links` Various links to learn more about the software e.g. `git` (where the source code can be found if it it's available), `website` (software's website if it exists) and `wikipedia` if there is some wiki. At least one of these needs to be there.
- `comment` about the software.
- `links` to learn more about the software e.g. `git` (where the source code can be found if it it's available), `website` (software's website if it exists) and `wikipedia` if there is some wiki. At least one of these needs to be there.
- `icon` a **link** to the icon of the software. For now no images will be stored in the repository so it takes up less space.
- `platforms` where the software can be accessed from e.g. Linux, Windows, Android, iOS, Mac. For websites just write `Web`.
- `interface` used to access the software, e.g. GTK, HTML5, JavaScript, Touch
- `languages` the main programming languages 40% or above that the software is made out of.
- `networks_read` if the software uses something like a [network](https://en.wikipedia.org/wiki/Social_networking_service). This means the software is able to view content on that network.
- `networks_write` if the software uses something like a [network](https://en.wikipedia.org/wiki/Social_networking_service). This means the software is able to do stuff like publish or write comments on the network.
- `formats_write` if the software can write files to your system what formats does it support.
@ -38,7 +40,7 @@ In the [apps](apps) folder there are a bunch of json files for software. Here is
# TO DO
- [x] Add interfaces and language parameters in json
- [x] Documentation parameter in json
- [ ] Make a script to make it easier to when creating software json files
- [ ] Make creating json files easier. Somehow......
## New software ideas
- [ ] Gitea