https://github.com/phoenicisorg/scripts

Phoenicis scripts
https://github.com/phoenicisorg/scripts

javascript wine

Last synced: about 2 months ago
JSON representation

Phoenicis scripts

• Host: GitHub
• URL: https://github.com/phoenicisorg/scripts
• Owner: PhoenicisOrg
• License: lgpl-3.0
• Created: 2016-12-20T15:54:37.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-04T10:25:58.000Z (9 months ago)
• Last Synced: 2024-05-04T11:28:26.105Z (9 months ago)
• Topics: javascript, wine
• Language: JavaScript
• Homepage:
• Size: 32.9 MB
• Stars: 64
• Watchers: 8
• Forks: 49
• Open Issues: 98
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ff0c41daa31549e4a9bb3998ca0c87ae)](https://www.codacy.com/app/PhoenicisOrg/scripts?utm_source=github.com&utm_medium=referral&utm_content=PhoenicisOrg/scripts&utm_campaign=Badge_Grade)

[![Crowdin Badge](https://d322cqt584bo4o.cloudfront.net/phoenicis-scripts/localized.svg)](https://crowdin.com/project/phoenicis-scripts)

# How to add a script

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

    ```

    git clone https://github.com//scripts.git

    cd scripts

    git checkout 

    ```

2. Add the local checkout as a local repository in Phoenicis (see [instructions](https://phoenicisorg.github.io/phoenicis/Users/repository/#local-directory))

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](https://phoenicisorg.github.io/scripts/Develop/script-js/): actual installation script

    * [script.json](https://phoenicisorg.github.io/scripts/Develop/script-json/): describes the installation script

        ```json

        {

		"scriptName": "Online",

		"compatibleOperatingSystems": ["MACOSX", "LINUX"],

		"testingOperatingSystems": [],

		"free": true,

		"requiresPatch": false

        }

        ```

    * main.png: application icon (400px x 300px)

    * [application.json](https://phoenicisorg.github.io/scripts/Develop/application-json/): describes the application

        ```json

        {

 		"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](https://phoenicisorg.github.io/scripts/General/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 \" (e.g. "Add 7-zip")

        * for an updated script: "Update \ \" (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](https://github.com/PhoenicisOrg/scripts/issues).