Mirrored_Repos/pluGET
1
0
Fork 0
mirror of https://github.com/Neocky/pluGET.git synced 2024-04-29 16:12:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added installer.bat help

Browse Source 
Changes:
- added installer.bat help
- changed formating of windows security message
This commit is contained in:
Neocky
2021-05-26 20:54:12 +02:00
committed by GitHub
parent afbc3e8029
commit 78f38f36cd
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -92,18 +92,25 @@ If you feel like showing your love and/or appreciation for this project then how
## Installation ## Installation
### Python ### 1. Python
Python needs to be installed on your machine. Python needs to be installed on your machine.
Get it [here](https://www.python.org/downloads/). Get it [here](https://www.python.org/downloads/).
### Dependencies ### 2. Dependencies
Install the needed packages for this project. Install the needed packages for this project.
#### Automatically (Windows only)
Execute the `installer.bat` file to automaticcally install the needed packages for this project.
> Sometimes the security warning `Windows protected your PC` comes when launching the `installer.bat` file.
> This is a normal behaviour from the windows defender because this is a unknown `.bat` file.
> To run the `installer.bat` anyway, click `More Info` and then `Run anyway` when the message pops up.
##### Manually
Execute this command in the `\plugGET` folder: Execute this command in the `\plugGET` folder:
```python ```python
py -m pip install -r requirements.txt py -m pip install -r requirements.txt
``` ```
### Edit the Config ### 3. Edit the Config
When run the first time, the `config.ini` file will be created in the `\src` folder and the program will close. When run the first time, the `config.ini` file will be created in the `\src` folder and the program will close.
Edit the config to your needs and relaunch pluGET. Edit the config to your needs and relaunch pluGET.
**Now you are good to go!** **Now you are good to go!**
@@ -112,9 +119,9 @@ Edit the config to your needs and relaunch pluGET.
### Windows: ### Windows:
Execute the `launcher.bat` in the `\pluGET` folder. Execute the `launcher.bat` in the `\pluGET` folder.
This will launch pluGET correctly. This will launch pluGET correctly.
Sometimes the security warning `Windows protected your PC` comes when launching the `launcher.bat` file. > Sometimes the security warning `Windows protected your PC` comes when launching the `launcher.bat` file.
This is a normal behaviour from the windows defender because this is a unknown `.bat` file. > This is a normal behaviour from the windows defender because this is a unknown `.bat` file.
To run the `launcher.bat` anyway, click `More Info` and then `Run anyway` when the message pops up. > To run the `launcher.bat` anyway, click `More Info` and then `Run anyway` when the message pops up.
### Linux: ### Linux:
Use `cd` to change into the `/pluGET` directory and change the permission of the `launcher.sh` to make it executeable: Use `cd` to change into the `/pluGET` directory and change the permission of the `launcher.sh` to make it executeable: