|
3 | 3 | [](https://crowdin.com/project/phoenicis-scripts) |
4 | 4 |
|
5 | 5 | # How to add a script |
6 | | -1. Clone this repository |
| 6 | +1. Fork this repository, create a new branch and clone it |
7 | 7 | ``` |
8 | | - git clone https://github.com/PhoenicisOrg/scripts.git |
| 8 | + git clone https://github.com/<user>/scripts.git |
| 9 | + cd scripts |
| 10 | + git checkout <branch> |
9 | 11 | ``` |
10 | 12 |
|
11 | 13 | 2. Add the local checkout as a local repository in Phoenicis (see [instructions](https://phoenicisorg.github.io/phoenicis/Users/repository/#local-directory)) |
12 | 14 |
|
13 | 15 | 3. Select the right category for the application |
14 | | - * Accessories |
15 | | - * Development |
16 | | - * Games |
17 | | - * Graphics |
18 | | - * Internet |
19 | | - * Multimedia |
20 | | - * Office |
21 | | - * Other |
22 | | - * Science |
| 16 | + * Accessories |
| 17 | + * Development |
| 18 | + * Games |
| 19 | + * Graphics |
| 20 | + * Internet |
| 21 | + * Multimedia |
| 22 | + * Office |
| 23 | + * Other |
| 24 | + * Science |
23 | 25 | |
24 | 26 | 4. Create a new folder for your script inside that category. The folder structure should be: |
25 | 27 | ``` |
|
38 | 40 | Even if the application name contains ®, ™ or the like, you should not use it in the folder name. |
39 | 41 |
|
40 | 42 | 5. Fill the files: |
41 | | - * [script.js](https://phoenicisorg.github.io/scripts/Develop/script-js/): actual installation script |
42 | | - * [script.json](https://phoenicisorg.github.io/scripts/Develop/script-json/): describes the installation script |
43 | | - ```json |
44 | | - { |
| 43 | + * [script.js](https://phoenicisorg.github.io/scripts/Develop/script-js/): actual installation script |
| 44 | + * [script.json](https://phoenicisorg.github.io/scripts/Develop/script-json/): describes the installation script |
| 45 | + ```json |
| 46 | + { |
45 | 47 | "scriptName": "Online", |
46 | 48 | "compatibleOperatingSystems": ["MACOSX", "LINUX"], |
47 | 49 | "testingOperatingSystems": [], |
48 | 50 | "free": true, |
49 | 51 | "requiresPatch": false |
50 | | - } |
51 | | - ``` |
52 | | - * main.png: application icon (400px x 300px) |
53 | | - * [application.json](https://phoenicisorg.github.io/scripts/Develop/application-json/): describes the application |
54 | | - ```json |
55 | | - { |
| 52 | + } |
| 53 | + ``` |
| 54 | + * main.png: application icon (400px x 300px) |
| 55 | + * [application.json](https://phoenicisorg.github.io/scripts/Develop/application-json/): describes the application |
| 56 | + ```json |
| 57 | + { |
56 | 58 | "name": "Steam", |
57 | 59 | "description": "Application description" |
58 | | - } |
59 | | - ``` |
| 60 | + } |
| 61 | + ``` |
60 | 62 | |
61 | | - 6. Verify changes: |
62 | | - * Ensure that the changes fulfill the code quality requirements and the files are formatted correctly (see [tools](https://phoenicisorg.github.io/scripts/General/tools/)). |
| 63 | +6. Verify changes: |
| 64 | + * Ensure that the changes fulfill the code quality requirements and the files are formatted correctly (see [tools](https://phoenicisorg.github.io/scripts/General/tools/)). |
63 | 65 | |
64 | | - 7. Create a pull request: |
65 | | - * Please create one pull request per script if you want to commit multiple scripts. |
66 | | - * use the following naming convention |
67 | | - * for a new script: "Add \<application name\>" (e.g. "Add 7-zip") |
68 | | - * for an updated script: "Update \<application name\> \<what changed\>" (e.g. "Update 7-zip to use Wine 2.1") |
| 66 | +7. Create a pull request: |
| 67 | + * Please create one pull request per script if you want to commit multiple scripts. |
| 68 | + * use the following naming convention |
| 69 | + * for a new script: "Add \<application name\>" (e.g. "Add 7-zip") |
| 70 | + * for an updated script: "Update \<application name\> \<what changed\>" (e.g. "Update 7-zip to use Wine 2.1") |
0 commit comments