|
| 1 | +# Premise |
| 2 | + |
| 3 | +The purpose of this catalog is closely related to the distribution of portable apps and AppImages via the AM package manager. To add an app, open an issue or a pull request at https://github.com/ivan-hc/AM |
| 4 | + |
| 5 | +This catalog is updated every half hour and is based entirely on this list: https://github.com/ivan-hc/AM/blob/main/programs/x86_64-apps |
| 6 | + |
| 7 | +If an app is added to this list, it means that an installation script has also been added here: https://github.com/ivan-hc/AM/tree/main/programs/x86_64 |
| 8 | + |
| 9 | +## If an app is **added** to AM |
| 10 | + - All lists will be automatically updated via https://github.com/ivan-hc/AM/blob/main/tools/am2pla-site |
| 11 | + - A new .md page will be created. It will use the description in that list and the URL specified in the installation script ("SITE" variable). |
| 12 | + - A new generic icon will be created using https://github.com/Portable-Linux-Apps/Portable-Linux-Apps.github.io/blob/main/no-icon.png |
| 13 | + |
| 14 | +## If an app is **removed** from AM |
| 15 | + - All references to it in the lists will be removed |
| 16 | + - The .md page will be removed |
| 17 | + - The icon will be removed |
| 18 | + |
| 19 | +## This project is powered by github actions, so... |
| 20 | +**...any attempt to add apps not listed in AM will be automatically overwritten!** |
| 21 | + |
| 22 | +However, you are allowed to add the correct icons and edit the pages of existing apps. |
| 23 | + |
| 24 | +------------------------------------ |
| 25 | + |
| 26 | +# Contributing |
| 27 | + |
| 28 | +This catalog is for everyone, so anyone can make a [pull request](https://github.com/Portable-Linux-Apps/Portable-Linux-Apps.github.io/pulls). |
| 29 | + |
| 30 | +## Add icons |
| 31 | + - Icons must be in PNG format and have the name of the referenced app (for example, the app `tizio` will have the icon `tizio.png`, all lowercase) |
| 32 | + - Icons must be 128x128 or smaller |
| 33 | + |
| 34 | +## Update app's pages |
| 35 | + - Write whatever you want, but leave the header (first line, the one starting with #) as is. |
| 36 | + - You can add buttons to the ones at the bottom, including a donation link. |
| 37 | + - You can add screenshots or GIFs. |
| 38 | + |
| 39 | +------------------------------------ |
| 40 | + |
| 41 | +# Conclusion |
| 42 | + |
| 43 | +If you are able to open an issue here, it means you have a GitHub account, and therefore you can make a pull request yourself. |
| 44 | + |
| 45 | +**You are strongly encouraged to actively participate in this project!** |
0 commit comments