adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs adjusted; various fixes to bot-usage.md and configuration.md

Browse Source
This commit is contained in:
hroff-1902 2019-08-13 00:10:33 +03:00
parent 90b75afdb1
commit 482847a994
2 changed files with 23 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/bot-usage.md
View File

@ -2,7 +2,7 @@
This page explains the different parameters of the bot and how to run it. This page explains the different parameters of the bot and how to run it.
!Note: !!! Note:
If you've used `setup.sh`, don't forget to activate your virtual environment (`source .env/bin/activate`) before running freqtrade commands. If you've used `setup.sh`, don't forget to activate your virtual environment (`source .env/bin/activate`) before running freqtrade commands.
@ -43,19 +43,22 @@ optional arguments:
--sd-notify Notify systemd service manager. --sd-notify Notify systemd service manager.
``` ```
### How to use a different configuration file? ### How to specify which configuration file be used?
The bot allows you to select which configuration file you want to use. Per The bot allows you to select which configuration file you want to use by means of
default, the bot will load the file `./config.json` the `-c/--config` command line option:
```bash ```bash
freqtrade -c path/far/far/away/config.json freqtrade -c path/far/far/away/config.json
``` ```
Per default, the bot loads the `config.json` configuration file from the current
working directory.
### How to use multiple configuration files? ### How to use multiple configuration files?
The bot allows you to use multiple configuration files by specifying multiple The bot allows you to use multiple configuration files by specifying multiple
`-c/--config` configuration options in the command line. Configuration parameters `-c/--config` options in the command line. Configuration parameters
defined in the last configuration file override parameters with the same name defined in the last configuration file override parameters with the same name
defined in the previous configuration file specified in the command line. defined in the previous configuration file specified in the command line.
@ -266,7 +269,7 @@ optional arguments:
## Edge commands ## Edge commands
To know your trade expectacny and winrate against historical data, you can use Edge. To know your trade expectancy and winrate against historical data, you can use Edge.
``` ```
usage: freqtrade edge [-h] [-i TICKER_INTERVAL] [--timerange TIMERANGE] usage: freqtrade edge [-h] [-i TICKER_INTERVAL] [--timerange TIMERANGE]

19
docs/configuration.md
View File

@ -1,15 +1,24 @@
# Configure the bot # Configure the bot
This page explains how to configure your `config.json` file. This page explains how to configure your configuration file.
## Setup config.json Per default, the bot loads configuration from the `config.json` file located in the current working directory.
You can change the configuration file used by the bot with the `-c/--config` option.
We recommend to copy and use the `config.json.example` as a template If you used the [Quick start](installation.md/#quick-start) method for installing
the bot, the installation script should have already created the default configuration file (`config.json`) for you.
We recommend you to copy and use the `config.json.example` as a template
for your bot configuration. for your bot configuration.
The table below will list all configuration parameters. The configuration file defines the set of configuration parameters for the bot written in the JSON format.
Additionally, you may use one-line `// ...` and multi-line `/* ... */` comments.
Mandatory Parameters are marked as **Required**. ## Configuration parameters
The table below will list all configuration parameters available.
Mandatory parameters are marked as **Required**.
| Command | Default | Description | | Command | Default | Description |
|----------|---------|-------------| |----------|---------|-------------|