Update the documentation from the PR review

This commit is contained in:
Gerald Lonlas 2018-01-02 18:50:12 -08:00
parent 284c6c4223
commit f37c495b90
3 changed files with 26 additions and 17 deletions

View File

@ -11,7 +11,10 @@ support multi exchanges and be controlled via Telegram.
## Disclaimer ## Disclaimer
This software is for educational purposes only. Do not risk money which This software is for educational purposes only. Do not risk money which
you are afraid to lose. Always start by running a trading bot in Dry-run and do not engage money you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS
AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.
Always start by running a trading bot in Dry-run and do not engage money
before you understand how it works and what profit/loss you should before you understand how it works and what profit/loss you should
expect. expect.
@ -31,7 +34,9 @@ hesitate to read the source code and understand the mechanism of this bot.
- [Basic Usage](#basic-usage) - [Basic Usage](#basic-usage)
- [Bot commands](#bot-commands) - [Bot commands](#bot-commands)
- [Telegram RPC commands](#telegram-rpc-commands) - [Telegram RPC commands](#telegram-rpc-commands)
- [Min hardware required](#min-hardware-required) - [Requirements](#requirements)
- [Min hardware required](#min-hardware-required)
- [Software requirements](#software-requirements)
## Branches ## Branches
The project is currently setup in two main branches: The project is currently setup in two main branches:
@ -41,7 +46,7 @@ breaking changes.
'should' be stable on this branch, and is generally well tested. 'should' be stable on this branch, and is generally well tested.
## Features ## Features
- [x] **Based on Python**: For botting on any operating system - - [x] **Based on Python 3.6+**: For botting on any operating system -
Windows, macOS and Linux Windows, macOS and Linux
- [x] **Persistence**: Persistence is achieved through sqlite - [x] **Persistence**: Persistence is achieved through sqlite
- [x] **Dry-run**: Run the bot without playing money. - [x] **Dry-run**: Run the bot without playing money.
@ -174,7 +179,16 @@ bot. More details on our
- `/help`: Show help message - `/help`: Show help message
- `/version`: Show version - `/version`: Show version
## Requirements
## Min hardware required ### Min hardware required
To run this bot we recommend you a cloud instance with a minimum of: To run this bot we recommend you a cloud instance with a minimum of:
* Minimal (advised) system requirements: 2GB RAM, 1GB disk space, 2vCPU * Minimal (advised) system requirements: 2GB RAM, 1GB disk space, 2vCPU
### Software requirements
- [Python 3.6.x](http://docs.python-guide.org/en/latest/starting/installation/)
- [pip](https://pip.pypa.io/en/stable/installing/)
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [TA-Lib](https://mrjbq7.github.io/ta-lib/install.html)
- [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) (Recommended)
- [Docker](https://www.docker.com/products/docker) (Recommended)

View File

@ -128,22 +128,22 @@ automatically. Testdata files will not be updated until your specify it.
### Run a backtesting against the currencies listed in your config file ### Run a backtesting against the currencies listed in your config file
**With 5 min tickers (Per default)** **With 5 min tickers (Per default)**
```bash ```bash
python3 ./freqtrade/main.py -c config.json backtesting --realistic-simulation python3 ./freqtrade/main.py backtesting --realistic-simulation
``` ```
**With 1 min tickers** **With 1 min tickers**
```bash ```bash
python3 ./freqtrade/main.py -c config.json backtesting --realistic-simulation --ticker-interval 1 python3 ./freqtrade/main.py backtesting --realistic-simulation --ticker-interval 1
``` ```
**Reload your testdata files** **Reload your testdata files**
```bash ```bash
python3 ./freqtrade/main.py -c config.json backtesting --realistic-simulation --refresh-pairs-cached python3 ./freqtrade/main.py backtesting --realistic-simulation --refresh-pairs-cached
``` ```
**With live data (do not alter your testdata files)** **With live data (do not alter your testdata files)**
```bash ```bash
python3 ./freqtrade/main.py -c config.json backtesting --realistic-simulation --live python3 ./freqtrade/main.py backtesting --realistic-simulation --live
``` ```
## Find optimal parameters with Hyperopt ## Find optimal parameters with Hyperopt

View File

@ -43,7 +43,7 @@ cd freqtrade
cp config.json.example config.json cp config.json.example config.json
``` ```
To edit the config please refer to the [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) page To edit the config please refer to the [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) page
5. Create your DB file 5. Create your DB file (Optional, the bot will create it if it is missing)
```bash ```bash
# For Production # For Production
touch tradesv3.sqlite touch tradesv3.sqlite
@ -171,16 +171,12 @@ If you are on a different Linux OS you maybe have to adapt things like:
### 2.3. MacOS installation ### 2.3. MacOS installation
**2.3.1. Install git and wget** **2.3.1. Install Python 3.6, git and wget**
```bash ```bash
brew install wget git brew install python3 git wget
``` ```
**2.3.2. Install Python 3.6** **2.3.2. [Optional] Install MongoDB**
- [Python 3.6 MacOS offical page](https://www.python.org/downloads/mac-osx/)
**2.3.3. [Optional] Install MongoDB**
Install MongoDB if you plan to optimize your strategy with Hyperopt. Install MongoDB if you plan to optimize your strategy with Hyperopt.
```bash ```bash
curl -O https://fastdl.mongodb.org/osx/mongodb-osx-ssl-x86_64-3.4.10.tgz curl -O https://fastdl.mongodb.org/osx/mongodb-osx-ssl-x86_64-3.4.10.tgz
@ -208,7 +204,6 @@ python3.6 -m venv .env
source .env/bin/activate source .env/bin/activate
pip3.6 install -r requirements.txt pip3.6 install -r requirements.txt
pip3.6 install -e . pip3.6 install -e .
pip3.6 install hyperopt
``` ```
## 6. Run the bot ## 6. Run the bot