Added new start pluGET topic

Changes:
- added docs to launch pluGET on linux
This commit is contained in:
Neocky 2021-03-28 17:41:55 +02:00 committed by GitHub
parent 31a2a4aa89
commit 2a7372dae1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -108,12 +108,25 @@ When run the first time, the `config.ini` file will be created in the root packa
Edit the config to your needs and relaunch pluGET.
**Now you are good to go!**
## Start pluGET
### Windows:
Execute the `launcher.bat` in the `\pluGET` folder.
This will launch pluGET correctly.
### Linux:
Use `cd` to change into the `/pluGET` directory and change the permission of the `launcher.sh` to make it executeable:
```
$ chmod +x launcher.sh
```
Execute the `launcher.sh` file:
```
$ ./launcher.sh
```
> On both OS you can also launch the `src/__main__.py` file.
## Usage
> As always, if you update plugins, shut down your server!
Execute the `launcher.bat` in the `\pluGET` folder. This will launch pluGET correctly.
Another way is to launch the `src\__main__.py` file.
The following are examples of input for the general usage:
(Hint: [thingsInBrackets] are optional & 'all' can always be exchanged through the plugin name or the plugin id and reverse)