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

Quick start and easy installation sections reworked

Browse Source
This commit is contained in:
hroff-1902 2019-11-08 19:38:32 +03:00 committed by GitHub
parent 54b63e89f8
commit 1f042f5e32
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/installation.md
View File

@ -26,10 +26,20 @@ You will need to create API Keys (Usually you get `key` and `secret`) from the E
## Quick start ## Quick start
Freqtrade provides a Linux/MacOS script to install all dependencies and help you to configure the bot. Freqtrade provides the Linux/MacOS Easy Installation script to install all dependencies and help you configure the bot.
!!! Note !!! Note
Python3.6 or higher and the corresponding `pip` are assumed to be available. The install-script will warn and stop if that's not the case. Windows installation is explained [here](#windows).
The easiest way to install and run Freqtrade is to clone the bot GitHub repository and then run the Easy Installation script, if it's available for your platform.
!!! Note "Version considerations"
When cloning the repository the default working branch has the name `develop`. This branch contains all last features (can be considered as relatively stable, thanks to automated tests). The `master` branch contains the code of the last release (done usually once per month on an approximately one week old snapshot of the `develop` branch to prevent packaging bugs, so potentially it's more stable).
!!! Note
Python3.6 or higher and the corresponding `pip` are assumed to be available. The install-script will warn you and stop if that's not the case. `git` is also needed to clone the Freqtrade repository.
This can be achieved with the following commands:
```bash ```bash
git clone git@github.com:freqtrade/freqtrade.git git clone git@github.com:freqtrade/freqtrade.git
@ -37,17 +47,11 @@ cd freqtrade
git checkout master # Optional, see (1) git checkout master # Optional, see (1)
./setup.sh --install ./setup.sh --install
``` ```
(1) This command switches the cloned repository to the use of the `master` branch. This command is not needed if you wish to stay on the `develop` branch. You may later switch between branches at any time with the `git checkout master`/`git checkout develop` commands. (1) This command switches the cloned repository to the use of the `master` branch. It's not needed if you wish to stay on the `develop` branch. You may later switch between branches at any time with the `git checkout master`/`git checkout develop` commands.
!!! Note "Version considerations" ## Easy Installation Script (Linux/MacOS)
When cloning the repository the default working branch has the name `develop`. This branch contains all last features (can be considered as relatively stable, thanks to automated tests). The `master` branch contains the code of the last release (done usually once per month on an approximately one week old snapshot of the `develop` branch to prevent packaging bugs, so potentially it's more stable).
!!! Note If you are on Debian, Ubuntu or MacOS Freqtrade provides the script to install, update, configure and reset the codebase of your bot.
Windows installation is explained [here](#windows).
## Easy Installation - Linux Script
If you are on Debian, Ubuntu or MacOS freqtrade provides a script to Install, Update, Configure, and Reset your bot.
```bash ```bash
$ ./setup.sh $ ./setup.sh
@ -60,25 +64,25 @@ usage:
** --install ** ** --install **
This script will install everything you need to run the bot: With this option, the script will install everything you need to run the bot:
* Mandatory software as: `ta-lib` * Mandatory software as: `ta-lib`
* Setup your virtualenv * Setup your virtualenv
* Configure your `config.json` file * Configure your `config.json` file
This script is a combination of `install script` `--reset`, `--config` This option is a combination of installation tasks, `--reset` and `--config`.
** --update ** ** --update **
Update parameter will pull the last version of your current branch and update your virtualenv. This option will pull the last version of your current branch and update your virtualenv. Run the script with this option periodically to update your bot.
** --reset ** ** --reset **
Reset parameter will hard reset your branch (only if you are on `master` or `develop`) and recreate your virtualenv. This option will hard reset your branch (only if you are on either `master` or `develop`) and recreate your virtualenv.
** --config ** ** --config **
Config parameter is a `config.json` configurator. This script will ask you questions to setup your bot and create your `config.json`. Use this option to configure the `config.json` configuration file. The script will interactively ask you questions to setup your bot and create your `config.json`.
------ ------