From 7a0be94cde48b89a04b3007f1a5b2d70e33182ca Mon Sep 17 00:00:00 2001 From: gcarq Date: Wed, 1 Nov 2017 18:32:27 +0100 Subject: [PATCH 1/2] adapt README --- README.md | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4388f00e3..796c734a3 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,12 @@ if not feel free to raise a github issue. #### Install +##### Arch Linux + +Use your favorite AUR helper and install `python-freqtrade-git`. + +##### Manually + `master` branch contains the latest stable release. `develop` branch has often new features, but might also cause breaking changes. To use it, you are encouraged to join our [slack channel](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE). @@ -75,20 +81,11 @@ $ pip install -e . $ ./freqtrade/main.py ``` -There is also an [article](https://www.sales4k.com/blockchain/high-frequency-trading-bot-tutorial/) about how to setup the bot (thanks [@gurghet](https://github.com/gurghet)). +There is also an [article](https://www.sales4k.com/blockchain/high-frequency-trading-bot-tutorial/) about how to setup the bot (thanks [@gurghet](https://github.com/gurghet)).* -#### Execute tests +\* *Note:* that article was written for an earlier version, so it may be outdated -``` -$ pytest -``` -This will by default skip the slow running backtest set. To run backtest set: - -``` -$ BACKTEST=true pytest -s freqtrade/tests/test_backtesting.py -``` - -#### Docker +##### Docker Building the image: @@ -136,6 +133,17 @@ $ docker start freqtrade You do not need to rebuild the image for configuration changes, it will suffice to edit `config.json` and restart the container. +#### Execute tests + +``` +$ pytest +``` +This will by default skip the slow running backtest set. To run backtest set: + +``` +$ BACKTEST=true pytest -s freqtrade/tests/test_backtesting.py +``` + #### Contributing Feel like our bot is missing a feature? We welcome your pull requests! Few pointers for contributions: From 3d61095ba45ab169afd0774ba7b4fd532c7722d7 Mon Sep 17 00:00:00 2001 From: gcarq Date: Wed, 1 Nov 2017 18:36:22 +0100 Subject: [PATCH 2/2] modify header font size --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 796c734a3..fa45b79e0 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ and enter the telegram `token` and your `chat_id` in `config.json` Persistence is achieved through sqlite. -#### Telegram RPC commands: +### Telegram RPC commands: * /start: Starts the trader * /stop: Stops the trader * /status: Lists all open trades @@ -24,7 +24,7 @@ Persistence is achieved through sqlite. * /forcesell : Instantly sells the given trade (Ignoring `minimum_roi`). * /performance: Show performance of each finished trade grouped by pair -#### Config +### Config `minimal_roi` is a JSON object where the key is a duration in minutes and the value is the minimum ROI in percent. See the example below: @@ -53,18 +53,18 @@ end up paying more then would probably have been necessary. The other values should be self-explanatory, if not feel free to raise a github issue. -#### Prerequisites +### Prerequisites * python3.6 * sqlite * [TA-lib](https://github.com/mrjbq7/ta-lib#dependencies) binaries -#### Install +### Install -##### Arch Linux +#### Arch Linux Use your favorite AUR helper and install `python-freqtrade-git`. -##### Manually +#### Manually `master` branch contains the latest stable release. @@ -85,7 +85,7 @@ There is also an [article](https://www.sales4k.com/blockchain/high-frequency-tra \* *Note:* that article was written for an earlier version, so it may be outdated -##### Docker +#### Docker Building the image: @@ -133,7 +133,7 @@ $ docker start freqtrade You do not need to rebuild the image for configuration changes, it will suffice to edit `config.json` and restart the container. -#### Execute tests +### Execute tests ``` $ pytest @@ -144,7 +144,7 @@ This will by default skip the slow running backtest set. To run backtest set: $ BACKTEST=true pytest -s freqtrade/tests/test_backtesting.py ``` -#### Contributing +### Contributing Feel like our bot is missing a feature? We welcome your pull requests! Few pointers for contributions: