This commit is contained in:
jyamihud 2022-04-01 09:04:03 +03:00
commit c93e7586a0
3 changed files with 22 additions and 7 deletions

View file

@ -2,15 +2,19 @@
A search tool for free software replacements. A search tool for free software replacements.
# How to add new software: # CONTRIBUTE!
## How to add new software:
In the [apps](apps) folder there are a bunch of json files for software. Here is an example: In the [apps](apps) folder there are a bunch of json files for software. Here is an example:
- `names` what the software is called. - `names` what the software is called.
- `comment` description of the software. - `comment` about 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. - `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. - `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`. - `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_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. - `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. - `formats_write` if the software can write files to your system what formats does it support.
@ -35,10 +39,19 @@ In the [apps](apps) folder there are a bunch of json files for software. Here is
"issues":["Surveillance", "Non-Free Software", "Non-Free JavaScript", "DRM"]} "issues":["Surveillance", "Non-Free Software", "Non-Free JavaScript", "DRM"]}
``` ```
## Create a `port.json`
When modifying the code, in order to test changes you need to rerun and put in the port number over and over. To solve this you can create a file called `port.json`:
```json
{
"port": "8080"
}
```
Now it will stop asking for port numbers and use the port you put in the json file.
# TO DO # TO DO
- [ ] Add interfaces and language parameters to search - [x] Add interfaces and language parameters in json
- [x] Documentation parameter 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 ## New software ideas
- [ ] Gitea - [ ] Gitea
@ -52,6 +65,8 @@ In the [apps](apps) folder there are a bunch of json files for software. Here is
- [ ] librarian - [ ] librarian
- [ ] fastlbry-terminal - [ ] fastlbry-terminal
- [ ] lyberry-qt - [ ] lyberry-qt
- [ ] palemoon
- [ ] icecat
## Nice to have ## Nice to have
- [ ] Make a way on the website editor to submit json files - [ ] Make a way on the website editor to submit json files

View file

@ -7,7 +7,7 @@
"licenses":["GPL3+"], "licenses":["GPL3+"],
"platforms":["Android"], "platforms":["Android"],
"interface":["Touch"], "interface":["Touch"],
"languages":["Java" "languages":["Java",
"Kotlin"], "Kotlin"],
"networks_read":["youtube", "networks_read":["youtube",
"peertube", "peertube",

View file

@ -1,7 +1,7 @@
{"names":["Piped"], {"names":["Piped"],
"comment": "YouTube has an extremely invasive privacy policy which relies on using user data in unethical ways. You give them a lot of data - ranging from ideas, music taste, content, political opinions, and much more than you think. By using Piped, you can freely watch and listen to content freely without the fear of prying eyes watching everything you are doing.", "comment": "YouTube has an extremely invasive privacy policy which relies on using user data in unethical ways. You give them a lot of data - ranging from ideas, music taste, content, political opinions, and much more than you think. By using Piped, you can freely watch and listen to content freely without the fear of prying eyes watching everything you are doing.",
"links":{"git":"https://github.com/TeamPiped/Piped#piped", "links":{"git":"https://github.com/TeamPiped/Piped#piped",
"website":"https://piped.kavin.rocks" "website":"https://piped.kavin.rocks",
"icon":"https://piped.kavin.rocks/img/icons/logo.svg"}, "icon":"https://piped.kavin.rocks/img/icons/logo.svg"},
"licenses":["AGPL3+"], "licenses":["AGPL3+"],
"platforms":["Web"], "platforms":["Web"],