From 5ef2654eb4d75d8c25cbba7cd1e0c5b3bec4ea7d Mon Sep 17 00:00:00 2001 From: xmatthias Date: Sun, 3 Jun 2018 23:07:00 +0200 Subject: [PATCH] replace references to old url replace garq with freqtrade --- .github/ISSUE_TEMPLATE.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 2 +- README.md | 48 ++++++++++++++++---------------- docs/backtesting.md | 4 +-- docs/bot-optimization.md | 8 +++--- docs/bot-usage.md | 6 ++-- docs/configuration.md | 8 +++--- docs/faq.md | 2 +- docs/hyperopt.md | 12 ++++---- docs/index.md | 48 ++++++++++++++++---------------- docs/installation.md | 16 +++++------ docs/sql_cheatsheet.md | 2 +- docs/telegram-usage.md | 2 +- 14 files changed, 81 insertions(+), 81 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 2cbbc59cb..2a6d3f18f 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,6 @@ ## Step 1: Have you search for this issue before posting it? -If you have discovered a bug in the bot, please [search our issue tracker](https://github.com/gcarq/freqtrade/issues?q=is%3Aissue). +If you have discovered a bug in the bot, please [search our issue tracker](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue). If it hasn't been reported, please create a new issue. ## Step 2: Describe your environment diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ae79dd8f0..20ef27f0f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,5 @@ Thank you for sending your pull request. But first, have you included -unit tests, and is your code PEP8 conformant? [More details](https://github.com/gcarq/freqtrade/blob/develop/CONTRIBUTING.md) +unit tests, and is your code PEP8 conformant? [More details](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md) ## Summary Explain in one sentence the goal of this PR diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93089495b..0cbe9167d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Feel like our bot is missing a feature? We welcome your pull requests! Few point conformant (max-line-length = 100). If you are unsure, discuss the feature on our [Slack](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE) -or in a [issue](https://github.com/gcarq/freqtrade/issues) before a PR. +or in a [issue](https://github.com/freqtrade/freqtrade/issues) before a PR. **Before sending the PR:** diff --git a/README.md b/README.md index 3ded0099a..24e01531c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # freqtrade -[![Build Status](https://travis-ci.org/gcarq/freqtrade.svg?branch=develop)](https://travis-ci.org/gcarq/freqtrade) -[![Coverage Status](https://coveralls.io/repos/github/gcarq/freqtrade/badge.svg?branch=develop&service=github)](https://coveralls.io/github/gcarq/freqtrade?branch=develop) -[![Maintainability](https://api.codeclimate.com/v1/badges/5737e6d668200b7518ff/maintainability)](https://codeclimate.com/github/gcarq/freqtrade/maintainability) +[![Build Status](https://travis-ci.org/freqtrade/freqtrade.svg?branch=develop)](https://travis-ci.org/freqtrade/freqtrade) +[![Coverage Status](https://coveralls.io/repos/github/freqtrade/freqtrade/badge.svg?branch=develop&service=github)](https://coveralls.io/github/freqtrade/freqtrade?branch=develop) +[![Maintainability](https://api.codeclimate.com/v1/badges/5737e6d668200b7518ff/maintainability)](https://codeclimate.com/github/freqtrade/freqtrade/maintainability) Simple High frequency trading bot for crypto currencies designed to support multi exchanges and be controlled via Telegram. -![freqtrade](https://raw.githubusercontent.com/gcarq/freqtrade/develop/docs/assets/freqtrade-screenshot.png) +![freqtrade](https://raw.githubusercontent.com/freqtrade/freqtrade/develop/docs/assets/freqtrade-screenshot.png) ## Disclaimer This software is for educational purposes only. Do not risk money which @@ -25,12 +25,12 @@ hesitate to read the source code and understand the mechanism of this bot. ## Table of Contents - [Features](#features) - [Quick start](#quick-start) -- [Documentations](https://github.com/gcarq/freqtrade/blob/develop/docs/index.md) - - [Installation](https://github.com/gcarq/freqtrade/blob/develop/docs/installation.md) - - [Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) - - [Strategy Optimization](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-optimization.md) - - [Backtesting](https://github.com/gcarq/freqtrade/blob/develop/docs/backtesting.md) - - [Hyperopt](https://github.com/gcarq/freqtrade/blob/develop/docs/hyperopt.md) +- [Documentations](https://github.com/freqtrade/freqtrade/blob/develop/docs/index.md) + - [Installation](https://github.com/freqtrade/freqtrade/blob/develop/docs/installation.md) + - [Configuration](https://github.com/freqtrade/freqtrade/blob/develop/docs/configuration.md) + - [Strategy Optimization](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-optimization.md) + - [Backtesting](https://github.com/freqtrade/freqtrade/blob/develop/docs/backtesting.md) + - [Hyperopt](https://github.com/freqtrade/freqtrade/blob/develop/docs/hyperopt.md) - [Support](#support) - [Help](#help--slack) - [Bugs](#bugs--issues) @@ -73,7 +73,7 @@ strategy parameters with real exchange data. ## Quick start This quick start section is a very short explanation on how to test the bot in dry-run. We invite you to read the -[bot documentation](https://github.com/gcarq/freqtrade/blob/develop/docs/index.md) +[bot documentation](https://github.com/freqtrade/freqtrade/blob/develop/docs/index.md) to ensure you understand how the bot is working. ### Easy installation @@ -87,7 +87,7 @@ The following steps are made for Linux/MacOS environment **1. Clone the repo** ```bash -git clone git@github.com:gcarq/freqtrade.git +git clone git@github.com:freqtrade/freqtrade.git git checkout develop cd freqtrade ``` @@ -109,26 +109,26 @@ For any questions not covered by the documentation or for further information about the bot, we encourage you to join our slack channel. - [Click here to join Slack channel](https://join.slack.com/t/highfrequencybot/shared_invite/enQtMjQ5NTM0OTYzMzY3LWMxYzE3M2MxNDdjMGM3ZTYwNzFjMGIwZGRjNTc3ZGU3MGE3NzdmZGMwNmU3NDM5ZTNmM2Y3NjRiNzk4NmM4OGE). -### [Bugs / Issues](https://github.com/gcarq/freqtrade/issues?q=is%3Aissue) +### [Bugs / Issues](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue) If you discover a bug in the bot, please -[search our issue tracker](https://github.com/gcarq/freqtrade/issues?q=is%3Aissue) +[search our issue tracker](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue) first. If it hasn't been reported, please -[create a new issue](https://github.com/gcarq/freqtrade/issues/new) and +[create a new issue](https://github.com/freqtrade/freqtrade/issues/new) and ensure you follow the template guide so that our team can assist you as quickly as possible. -### [Feature Requests](https://github.com/gcarq/freqtrade/labels/enhancement) +### [Feature Requests](https://github.com/freqtrade/freqtrade/labels/enhancement) Have you a great idea to improve the bot you want to share? Please, -first search if this feature was not [already discussed](https://github.com/gcarq/freqtrade/labels/enhancement). +first search if this feature was not [already discussed](https://github.com/freqtrade/freqtrade/labels/enhancement). If it hasn't been requested, please -[create a new request](https://github.com/gcarq/freqtrade/issues/new) +[create a new request](https://github.com/freqtrade/freqtrade/issues/new) and ensure you follow the template guide so that it does not get lost in the bug reports. -### [Pull Requests](https://github.com/gcarq/freqtrade/pulls) +### [Pull Requests](https://github.com/freqtrade/freqtrade/pulls) Feel like our bot is missing a feature? We welcome your pull requests! Please read our -[Contributing document](https://github.com/gcarq/freqtrade/blob/develop/CONTRIBUTING.md) +[Contributing document](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md) to understand the requirements before sending your pull-requests. **Important:** Always create your PR against the `develop` branch, not @@ -171,14 +171,14 @@ optional arguments: only if dry_run is enabled. ``` More details on: -- [How to run the bot](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md#bot-commands) -- [How to use Backtesting](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md#backtesting-commands) -- [How to use Hyperopt](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md#hyperopt-commands) +- [How to run the bot](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md#bot-commands) +- [How to use Backtesting](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md#backtesting-commands) +- [How to use Hyperopt](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md#hyperopt-commands) ### Telegram RPC commands Telegram is not mandatory. However, this is a great way to control your bot. More details on our -[documentation](https://github.com/gcarq/freqtrade/blob/develop/docs/index.md) +[documentation](https://github.com/freqtrade/freqtrade/blob/develop/docs/index.md) - `/start`: Starts the trader - `/stop`: Stops the trader diff --git a/docs/backtesting.md b/docs/backtesting.md index 0b53d45b7..ac743dcac 100644 --- a/docs/backtesting.md +++ b/docs/backtesting.md @@ -14,7 +14,7 @@ real data. This is what we call Backtesting will use the crypto-currencies (pair) from your config file and load static tickers located in -[/freqtrade/tests/testdata](https://github.com/gcarq/freqtrade/tree/develop/freqtrade/tests/testdata). +[/freqtrade/tests/testdata](https://github.com/freqtrade/freqtrade/tree/develop/freqtrade/tests/testdata). If the 5 min and 1 min ticker for the crypto-currencies to test is not already in the `testdata` folder, backtesting will download them automatically. Testdata files will not be updated until you specify it. @@ -166,4 +166,4 @@ strategies, your configuration, and the crypto-currency you have set up. ## Next step Great, your strategy is profitable. What if the bot can give your the optimal parameters to use for your strategy? -Your next step is to learn [how to find optimal parameters with Hyperopt](https://github.com/gcarq/freqtrade/blob/develop/docs/hyperopt.md) +Your next step is to learn [how to find optimal parameters with Hyperopt](https://github.com/freqtrade/freqtrade/blob/develop/docs/hyperopt.md) diff --git a/docs/bot-optimization.md b/docs/bot-optimization.md index b9ff3fe40..bdb21928e 100644 --- a/docs/bot-optimization.md +++ b/docs/bot-optimization.md @@ -49,7 +49,7 @@ If you want to use a strategy from a different folder you can pass `--strategy-p python3 ./freqtrade/main.py --strategy AwesomeStrategy --strategy-path /some/folder ``` -**For the following section we will use the [user_data/strategies/test_strategy.py](https://github.com/gcarq/freqtrade/blob/develop/user_data/strategies/test_strategy.py) +**For the following section we will use the [user_data/strategies/test_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py) file as reference.** ### Buy strategy @@ -138,15 +138,15 @@ def populate_indicators(dataframe: DataFrame) -> DataFrame: ``` **Want more indicators example?** -Look into the [user_data/strategies/test_strategy.py](https://github.com/gcarq/freqtrade/blob/develop/user_data/strategies/test_strategy.py). +Look into the [user_data/strategies/test_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py). Then uncomment indicators you need. ### Where is the default strategy? The default buy strategy is located in the file -[freqtrade/default_strategy.py](https://github.com/gcarq/freqtrade/blob/develop/freqtrade/strategy/default_strategy.py). +[freqtrade/default_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/strategy/default_strategy.py). ## Next step Now you have a perfect strategy you probably want to backtesting it. -Your next step is to learn [How to use the Backtesting](https://github.com/gcarq/freqtrade/blob/develop/docs/backtesting.md). +Your next step is to learn [How to use the Backtesting](https://github.com/freqtrade/freqtrade/blob/develop/docs/backtesting.md). diff --git a/docs/bot-usage.md b/docs/bot-usage.md index cfffd04e9..815fed672 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -68,7 +68,7 @@ python3 ./freqtrade/main.py --strategy AwesomeStrategy If the bot does not find your strategy file, it will display in an error message the reason (File not found, or errors in your code). -Learn more about strategy file in [optimize your bot](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-optimization.md). +Learn more about strategy file in [optimize your bot](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-optimization.md). ### How to use --strategy-path? This parameter allows you to add an additional strategy lookup path, which gets @@ -189,9 +189,9 @@ optional arguments: ## A parameter missing in the configuration? All parameters for `main.py`, `backtesting`, `hyperopt` are referenced -in [misc.py](https://github.com/gcarq/freqtrade/blob/develop/freqtrade/misc.py#L84) +in [misc.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/misc.py#L84) ## Next step The optimal strategy of the bot will change with time depending of the market trends. The next step is to -[optimize your bot](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-optimization.md). +[optimize your bot](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-optimization.md). diff --git a/docs/configuration.md b/docs/configuration.md index a2df3f2fe..bd867857c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -40,7 +40,7 @@ The table below will list all configuration parameters. | `internals.process_throttle_secs` | 5 | Yes | Set the process throttle. Value in second. The definition of each config parameters is in -[misc.py](https://github.com/gcarq/freqtrade/blob/develop/freqtrade/misc.py#L205). +[misc.py](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/misc.py#L205). ### Understand minimal_roi `minimal_roi` is a JSON object where the key is a duration @@ -141,12 +141,12 @@ you run it in production mode. "key": "af8ddd35195e9dc500b9a6f799f6f5c93d89193b", "secret": "08a9dc6db3d7b53e1acebd9275677f4b0a04f1a5", ... -} +} ``` If you have not your Bittrex API key yet, -[see our tutorial](https://github.com/gcarq/freqtrade/blob/develop/docs/pre-requisite.md). +[see our tutorial](https://github.com/freqtrade/freqtrade/blob/develop/docs/pre-requisite.md). ## Next step Now you have configured your config.json, the next step is to -[start your bot](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md). +[start your bot](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md). diff --git a/docs/faq.md b/docs/faq.md index b3f15613a..31a302067 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -27,7 +27,7 @@ like pauses. You can stop your bot, adjust settings and start it again. #### I want to improve the bot with a new strategy That's great. We have a nice backtesting and hyperoptimizing setup. See -the tutorial [here|Testing-new-strategies-with-Hyperopt](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md#hyperopt-commands). +the tutorial [here|Testing-new-strategies-with-Hyperopt](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md#hyperopt-commands). #### Is there a setting to only SELL the coins being held and not perform anymore BUYS? diff --git a/docs/hyperopt.md b/docs/hyperopt.md index 0bfa9ae2d..a079e34df 100644 --- a/docs/hyperopt.md +++ b/docs/hyperopt.md @@ -14,13 +14,13 @@ parameters with Hyperopt. ## Prepare Hyperopt Before we start digging in Hyperopt, we recommend you to take a look at -your strategy file located into [user_data/strategies/](https://github.com/gcarq/freqtrade/blob/develop/user_data/strategies/test_strategy.py) +your strategy file located into [user_data/strategies/](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py) ### 1. Configure your Guards and Triggers There are two places you need to change in your strategy file to add a new buy strategy for testing: -- Inside [populate_buy_trend()](https://github.com/gcarq/freqtrade/blob/develop/user_data/strategies/test_strategy.py#L278-L294). -- Inside [hyperopt_space()](https://github.com/gcarq/freqtrade/blob/develop/user_data/strategies/test_strategy.py#L244-L297) known as `SPACE`. +- Inside [populate_buy_trend()](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py#L278-L294). +- Inside [hyperopt_space()](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py#L244-L297) known as `SPACE`. There you have two different type of indicators: 1. `guards` and 2. `triggers`. @@ -110,13 +110,13 @@ cannot use your config file. It is also made on purpose to allow you testing your strategy with different configurations. The Hyperopt configuration is located in -[user_data/hyperopt_conf.py](https://github.com/gcarq/freqtrade/blob/develop/user_data/hyperopt_conf.py). +[user_data/hyperopt_conf.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/hyperopt_conf.py). ## Advanced notions ### Understand the Guards and Triggers When you need to add the new guards and triggers to be hyperopt -parameters, you do this by adding them into the [hyperopt_space()](https://github.com/gcarq/freqtrade/blob/develop/user_data/strategies/test_strategy.py#L244-L297). +parameters, you do this by adding them into the [hyperopt_space()](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py#L244-L297). If it's a trigger, you add one line to the 'trigger' choice group and that's it. @@ -312,4 +312,4 @@ def populate_buy_trend(self, dataframe: DataFrame) -> DataFrame: ## Next step Now you have a perfect bot and want to control it from Telegram. Your -next step is to learn the [Telegram usage](https://github.com/gcarq/freqtrade/blob/develop/docs/telegram-usage.md). +next step is to learn the [Telegram usage](https://github.com/freqtrade/freqtrade/blob/develop/docs/telegram-usage.md). diff --git a/docs/index.md b/docs/index.md index ed940d132..afde2d5eb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,27 +6,27 @@ Pull-request. Do not hesitate to reach us on if you do not find the answer to your questions. ## Table of Contents -- [Pre-requisite](https://github.com/gcarq/freqtrade/blob/develop/docs/pre-requisite.md) - - [Setup your Bittrex account](https://github.com/gcarq/freqtrade/blob/develop/docs/pre-requisite.md#setup-your-bittrex-account) - - [Setup your Telegram bot](https://github.com/gcarq/freqtrade/blob/develop/docs/pre-requisite.md#setup-your-telegram-bot) -- [Bot Installation](https://github.com/gcarq/freqtrade/blob/develop/docs/installation.md) - - [Install with Docker (all platforms)](https://github.com/gcarq/freqtrade/blob/develop/docs/installation.md#docker) - - [Install on Linux Ubuntu](https://github.com/gcarq/freqtrade/blob/develop/docs/installation.md#21-linux---ubuntu-1604) - - [Install on MacOS](https://github.com/gcarq/freqtrade/blob/develop/docs/installation.md#23-macos-installation) - - [Install on Windows](https://github.com/gcarq/freqtrade/blob/develop/docs/installation.md#windows) -- [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) -- [Bot usage (Start your bot)](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md) - - [Bot commands](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md#bot-commands) - - [Backtesting commands](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md#backtesting-commands) - - [Hyperopt commands](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-usage.md#hyperopt-commands) -- [Bot Optimization](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-optimization.md) - - [Change your strategy](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-optimization.md#change-your-strategy) - - [Add more Indicator](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-optimization.md#add-more-indicator) - - [Test your strategy with Backtesting](https://github.com/gcarq/freqtrade/blob/develop/docs/backtesting.md) - - [Find optimal parameters with Hyperopt](https://github.com/gcarq/freqtrade/blob/develop/docs/hyperopt.md) -- [Control the bot with telegram](https://github.com/gcarq/freqtrade/blob/develop/docs/telegram-usage.md) -- [Contribute to the project](https://github.com/gcarq/freqtrade/blob/develop/CONTRIBUTING.md) - - [How to contribute](https://github.com/gcarq/freqtrade/blob/develop/CONTRIBUTING.md) - - [Run tests & Check PEP8 compliance](https://github.com/gcarq/freqtrade/blob/develop/CONTRIBUTING.md) -- [FAQ](https://github.com/gcarq/freqtrade/blob/develop/docs/faq.md) - - [SQL cheatsheet](https://github.com/gcarq/freqtrade/blob/develop/docs/sql_cheatsheet.md) \ No newline at end of file +- [Pre-requisite](https://github.com/freqtrade/freqtrade/blob/develop/docs/pre-requisite.md) + - [Setup your Bittrex account](https://github.com/freqtrade/freqtrade/blob/develop/docs/pre-requisite.md#setup-your-bittrex-account) + - [Setup your Telegram bot](https://github.com/freqtrade/freqtrade/blob/develop/docs/pre-requisite.md#setup-your-telegram-bot) +- [Bot Installation](https://github.com/freqtrade/freqtrade/blob/develop/docs/installation.md) + - [Install with Docker (all platforms)](https://github.com/freqtrade/freqtrade/blob/develop/docs/installation.md#docker) + - [Install on Linux Ubuntu](https://github.com/freqtrade/freqtrade/blob/develop/docs/installation.md#21-linux---ubuntu-1604) + - [Install on MacOS](https://github.com/freqtrade/freqtrade/blob/develop/docs/installation.md#23-macos-installation) + - [Install on Windows](https://github.com/freqtrade/freqtrade/blob/develop/docs/installation.md#windows) +- [Bot Configuration](https://github.com/freqtrade/freqtrade/blob/develop/docs/configuration.md) +- [Bot usage (Start your bot)](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md) + - [Bot commands](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md#bot-commands) + - [Backtesting commands](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md#backtesting-commands) + - [Hyperopt commands](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-usage.md#hyperopt-commands) +- [Bot Optimization](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-optimization.md) + - [Change your strategy](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-optimization.md#change-your-strategy) + - [Add more Indicator](https://github.com/freqtrade/freqtrade/blob/develop/docs/bot-optimization.md#add-more-indicator) + - [Test your strategy with Backtesting](https://github.com/freqtrade/freqtrade/blob/develop/docs/backtesting.md) + - [Find optimal parameters with Hyperopt](https://github.com/freqtrade/freqtrade/blob/develop/docs/hyperopt.md) +- [Control the bot with telegram](https://github.com/freqtrade/freqtrade/blob/develop/docs/telegram-usage.md) +- [Contribute to the project](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md) + - [How to contribute](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md) + - [Run tests & Check PEP8 compliance](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md) +- [FAQ](https://github.com/freqtrade/freqtrade/blob/develop/docs/faq.md) + - [SQL cheatsheet](https://github.com/freqtrade/freqtrade/blob/develop/docs/sql_cheatsheet.md) diff --git a/docs/installation.md b/docs/installation.md index be8e2e501..850b2c255 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,7 +2,7 @@ This page explains how to prepare your environment for running the bot. -To understand how to set up the bot please read the [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) page. +To understand how to set up the bot please read the [Bot Configuration](https://github.com/freqtrade/freqtrade/blob/develop/docs/configuration.md) page. ## Table of Contents @@ -69,7 +69,7 @@ Once you have Docker installed, simply create the config file (e.g. `config.json #### 1.1. Clone the git repository ```bash -git clone https://github.com/gcarq/freqtrade.git +git clone https://github.com/freqtrade/freqtrade.git ``` #### 1.2. (Optional) Checkout the develop branch @@ -90,7 +90,7 @@ cd freqtrade cp -n 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/freqtrade/freqtrade/blob/develop/docs/configuration.md) page. #### 1.5. Create your database file *(optional - the bot will create it if it is missing)* @@ -237,7 +237,7 @@ sudo apt-get install mongodb-org Clone the git repository: ```bash -git clone https://github.com/gcarq/freqtrade.git +git clone https://github.com/freqtrade/freqtrade.git ``` Optionally checkout the develop branch: @@ -287,7 +287,7 @@ export PATH=/env/mongodb/bin:$PATH Clone the git repository: ```bash -git clone https://github.com/gcarq/freqtrade.git +git clone https://github.com/freqtrade/freqtrade.git ``` Optionally checkout the develop branch: @@ -306,7 +306,7 @@ cd freqtrade cp config.json.example config.json ``` -> *To edit the config please refer to [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md).* +> *To edit the config please refer to [Bot Configuration](https://github.com/freqtrade/freqtrade/blob/develop/docs/configuration.md).* #### 2. Setup your Python virtual environment (virtualenv) @@ -350,8 +350,8 @@ copy paste `config.json` to ``\path\freqtrade-develop\freqtrade` >python main.py ``` -> Thanks [Owdr](https://github.com/Owdr) for the commands. Source: [Issue #222](https://github.com/gcarq/freqtrade/issues/222) +> Thanks [Owdr](https://github.com/Owdr) for the commands. Source: [Issue #222](https://github.com/freqtrade/freqtrade/issues/222) Now you have an environment ready, the next step is -[Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md)... +[Bot Configuration](https://github.com/freqtrade/freqtrade/blob/develop/docs/configuration.md)... diff --git a/docs/sql_cheatsheet.md b/docs/sql_cheatsheet.md index 141eaeafe..ba26f1707 100644 --- a/docs/sql_cheatsheet.md +++ b/docs/sql_cheatsheet.md @@ -85,7 +85,7 @@ INSERT INTO trades (exchange, pair, is_open, fee_open, fee_close, open_rate, sta ## Fix wrong fees in the table If your DB was created before -[PR#200](https://github.com/gcarq/freqtrade/pull/200) was merged +[PR#200](https://github.com/freqtrade/freqtrade/pull/200) was merged (before 12/23/17). ```sql diff --git a/docs/telegram-usage.md b/docs/telegram-usage.md index 20e80269b..4f878dbd1 100644 --- a/docs/telegram-usage.md +++ b/docs/telegram-usage.md @@ -4,7 +4,7 @@ This page explains how to command your bot with Telegram. ## Pre-requisite To control your bot with Telegram, you need first to -[set up a Telegram bot](https://github.com/gcarq/freqtrade/blob/develop/docs/pre-requisite.md) +[set up a Telegram bot](https://github.com/freqtrade/freqtrade/blob/develop/docs/pre-requisite.md) and add your Telegram API keys into your config file. ## Telegram commands