Skip to content

Commit 1a21498

Browse files
authored
README: use a fork (#786)
1 parent 89ced58 commit 1a21498

1 file changed

Lines changed: 32 additions & 30 deletions

File tree

README.md

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,25 @@
33
[![Crowdin Badge](https://d322cqt584bo4o.cloudfront.net/phoenicis-scripts/localized.svg)](https://crowdin.com/project/phoenicis-scripts)
44

55
# How to add a script
6-
1. Clone this repository
6+
1. Fork this repository, create a new branch and clone it
77
```
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>
911
```
1012
1113
2. Add the local checkout as a local repository in Phoenicis (see [instructions](https://phoenicisorg.github.io/phoenicis/Users/repository/#local-directory))
1214
1315
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
2325
2426
4. Create a new folder for your script inside that category. The folder structure should be:
2527
```
@@ -38,31 +40,31 @@
3840
Even if the application name contains ®, ™ or the like, you should not use it in the folder name.
3941
4042
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+
{
4547
"scriptName": "Online",
4648
"compatibleOperatingSystems": ["MACOSX", "LINUX"],
4749
"testingOperatingSystems": [],
4850
"free": true,
4951
"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+
{
5658
"name": "Steam",
5759
"description": "Application description"
58-
}
59-
```
60+
}
61+
```
6062
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/)).
6365
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

Comments
 (0)