mirror of
https://github.com/NohamR/Ratio.py.git
synced 2025-05-24 00:38:57 +00:00
feat: improve instructions
This commit is contained in:
parent
859d49d34e
commit
ffe299edda
48
README.md
48
README.md
@ -2,32 +2,41 @@
|
||||
|
||||
Ratio.py is a small command line RatioMaster.Net like in Python3. It fakes upload stats of a torrent.
|
||||
Current emulators available are:
|
||||
* Transmission 3.00
|
||||
|
||||
## Requirements:
|
||||
- Transmission 3.00
|
||||
|
||||
### Requirements
|
||||
|
||||
1. Python 3.x
|
||||
2. pip install -r requirements.txt
|
||||
3. a torrent file (use one with lots of leechers)
|
||||
|
||||
## Usage:
|
||||
### Download
|
||||
|
||||
Using `git` command:
|
||||
|
||||
```bash
|
||||
foo@bar: ~/Ratio.py $ python3 ratio.py -c config.json
|
||||
git clone https://github.com/garnajee/Ratio.py.git
|
||||
```
|
||||
|
||||
To run (multiple instances) in background :
|
||||
Or using `cURL`:
|
||||
|
||||
```bash
|
||||
foo@bar: ~/Ratio.py $ nohup python3 ratio.py -c config.json &
|
||||
foo@bar: ~/Ratio.py $ nohup python3 ratio.py -c config.json &> nohup2.out &
|
||||
curl -L https://github.com/garnajee/Ratio.py/archive/master.tar.gz -o Ratio.py.tar.gz
|
||||
tar xzf Ratio.py.tar.gz
|
||||
rm Ratio.py.tar.gz
|
||||
mv Ratio.py-master Ratio.py
|
||||
```
|
||||
|
||||
View logs :
|
||||
Navigate to the folder:
|
||||
|
||||
```bash
|
||||
foo@bar: ~/Ratio.py $ tail -f nohup.out
|
||||
cd Ratio.py
|
||||
```
|
||||
|
||||
## Configuration example
|
||||
Then configure your `config.json` file.
|
||||
|
||||
### Configuration example
|
||||
|
||||
```js
|
||||
{
|
||||
@ -36,5 +45,24 @@ foo@bar: ~/Ratio.py $ tail -f nohup.out
|
||||
}
|
||||
```
|
||||
|
||||
### Usage:
|
||||
|
||||
```bash
|
||||
python3 ratio.py -c config.json
|
||||
```
|
||||
|
||||
To run (multiple instances) in background :
|
||||
|
||||
```bash
|
||||
nohup python3 ratio.py -c config.json &
|
||||
nohup python3 ratio.py -c config.json &> nohup2.out &
|
||||
```
|
||||
|
||||
View logs :
|
||||
|
||||
```bash
|
||||
tail -f nohup.out
|
||||
```
|
||||
|
||||
*This project is an updated fork of [this project](https://github.com/MisterDaneel/Ratio.py).*
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user