How to add a script

1. Fork this repository, create a new branch and clone it

   git clone https://github.com/<user>/scripts.git
   cd scripts
   git checkout <branch>
   

2. Add the local checkout as a local repository in Phoenicis (see instructions)

3. Select the right category for the application

   • Accessories
   • Development
   • Games
   • Graphics
   • Internet
   • Multimedia
   • Office
   • Other
   • Science

4. Create a new folder for your script inside that category. The folder structure should be:

   category
   └── application-name
       ├── script-name
       │   ├── script.js
       │   └── script.json
       ├── miniatures
       │   └── main.png
       └── application.json
   

   Typically, script-name will be something like "Steam", "Online" or "v1.2".

   Even if the application name contains ®, ™ or the like, you should not use it in the folder name.

5. Fill the files:

   • script.js: actual installation script
   • script.json: describes the installation script

     {
     "scriptName": "Online",
     "compatibleOperatingSystems": ["MACOSX", "LINUX"],
     "testingOperatingSystems": [],
     "free": true,
     "requiresPatch": false
     }

   • main.png: application icon (400px x 300px)
   • application.json: describes the application

     {
     "name":	"Steam",
     "description": "Application description"
     }

6. Verify changes:

   • Ensure that the changes fulfill the code quality requirements and the files are formatted correctly (see tools).

7. Create a pull request:

   • Please create one pull request per script if you want to commit multiple scripts.
   • use the following naming convention
     • for a new script: "Add <application name>" (e.g. "Add 7-zip")
     • for an updated script: "Update <application name> <what changed>" (e.g. "Update 7-zip to use Wine 2.1")

Translate

Phoenicis scripts are localized using Crowdin: https://crowdin.com/project/phoenicis-scripts If your language is not listed, please create an issue.