Major readme change

This commit is contained in:
Drazzilb 2021-11-20 18:33:41 -08:00 committed by GitHub
parent 5f858cdd04
commit f704208a4b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -12,71 +12,7 @@ This is a program used to manage your qBittorrent instance such as:
## Installation
* Dependencies
* Requires `python 3`
### Unraid Installation
* [Guide to setup on Unraid](https://github.com/StuffAnThings/qbit_manage/wiki/qBit-Manager-on-unRAID)
### *Nix Installation
* Download the script
```bash
wget -O qbit_manage.py 'https://raw.githubusercontent.com/StuffAnThings/qbit_manage/master/qbit_manage.py'
```
* Make it executable
```bash
chmod +x qbit_manage.py
```
* Get & Install Requirements
```bash
wget -O requirements.txt 'https://raw.githubusercontent.com/StuffAnThings/qbit_manage/master/requirements.txt'
pip install -r requirements.txt
```
* Get Example Config
```bash
wget -O config.yml.sample 'https://raw.githubusercontent.com/StuffAnThings/qbit_manage/master/config.yml.sample'
```
* Create Config
```bash
cp config.yml.sample config.yml
nano -e config.yml
```
* Updating
```bash
wget -O qbit_manage.py 'https://raw.githubusercontent.com/StuffAnThings/qbit_manage/master/qbit_manage.py'
chmod +x qbit_manage.py
wget -O requirements.txt 'https://raw.githubusercontent.com/StuffAnThings/qbit_manage/master/requirements.txt'
pip install -r requirements.txt
wget -O config.yml.sample 'https://raw.githubusercontent.com/StuffAnThings/qbit_manage/master/config.yml.sample'
diff -ui config.yml config.yml.sample
```
#### Other Local Installation
* Requires `python 3`. Dependencies must be installed by running:
```bash
pip install -r requirements.txt
```
If there are issues installing dependencies try:
```bash
pip install -r requirements.txt --ignore-installed
```
Check out the [wiki](https://github.com/StuffAnThings/qbit_manage/wiki) for installation help
## Usage