diff --git a/docs/installation.md b/docs/installation.md index db15130d9..339f521df 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -9,19 +9,25 @@ The freqtrade documentation describes various ways to install freqtrade * [Manual Installation](#manual-installation) * [Installation with Conda](#installation-with-conda) -Please consider using the prebuilt [docker images](docker_quickstart.md) to get started quickly while evaluating how freqtrade works. +Please consider using the prebuilt [docker images](docker_quickstart.md) to get started quickly. !!! Note "Updating" Keeping freqtrade updated is important to [ensure ongoing compatibility](updating.md#why-update) with exchange API's. Please refer to the [updating guide](updating.md) for details on how to update your installation. +!!! Note "Windows users" + We **strongly** recommend that Windows users use [Docker](docker_quickstart.md) as this will work much easier and smoother (also more secure). + + If that is not possible, try using the Windows Linux subsystem (WSL) - for which the Ubuntu/Linux instructions will work. + If you really want to install freqtrade natively on Windows, best use the [`./setup.ps1` installation script](#use-setupps1-windows). + + Please also make sure to use the 64bit version of Python, as 32bit versions have severe memory limitations, which can negatively impact your experience with backtesting/hyperopt. + ------ ## Information -For Windows installation, please use the [windows installation guide](windows_installation.md). - -The easiest way to install and run Freqtrade is to clone the bot Github repository and then run the `./setup.sh` script, if it's available for your platform. +The easiest way to install and run Freqtrade is to clone the bot Github repository and then run the `./setup.sh` (`./setup.ps1` for Windows) 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). @@ -156,6 +162,16 @@ If you are on Debian, Ubuntu or MacOS, freqtrade provides the script to install ./setup.sh -i ``` +### Use ./setup.ps1 (Windows) + +The script will ask you a few questions to determine which parts should be installed. + +```powershell +Set-ExecutionPolicy -ExecutionPolicy Bypass +cd freqtrade +. .\setup.ps1 +``` + ### Activate your virtual environment Each time you open a new terminal, you must run `source .venv/bin/activate` to activate your virtual environment. @@ -341,7 +357,7 @@ conda deactivate Happy trading! ------ +------ ## You are ready @@ -398,3 +414,15 @@ open /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10 ``` If this file is inexistent, then you're probably on a different version of MacOS, so you may need to consult the internet for specific resolution details. + +### Windows Installation error + +``` bash +error: Microsoft Visual C++ 14.0 is required. Get it with "Microsoft Visual C++ Build Tools": http://landinghub.visualstudio.com/visual-cpp-build-tools +``` + +Unfortunately, many packages requiring compilation don't provide a pre-built wheel. It is therefore mandatory to have a C/C++ compiler installed and available for your python environment to use. + +You can download the Visual C++ build tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/) and install "Desktop development with C++" in it's default configuration. Unfortunately, this is a heavy download / dependency so you might want to consider WSL2 or [docker compose](docker_quickstart.md) first. + +![Windows installation](assets/windows_install.png) diff --git a/docs/updating.md b/docs/updating.md index 8f5438b82..ae9135af9 100644 --- a/docs/updating.md +++ b/docs/updating.md @@ -52,4 +52,4 @@ We try to make sure that heavy dependencies have wheels available for major plat Please refer to the corresponding installation sections (common problem sections linked below). [Common installation problems](installation.md#troubleshooting) -[Common installation problems - windows](windows_installation.md#error-during-installation-on-windows) +[Common installation problems - windows](installation.md#windows-installation-error) diff --git a/docs/windows_installation.md b/docs/windows_installation.md deleted file mode 100644 index ef7444da0..000000000 --- a/docs/windows_installation.md +++ /dev/null @@ -1,57 +0,0 @@ -# Windows installation - -We **strongly** recommend that Windows users use [Docker](docker_quickstart.md) as this will work much easier and smoother (also more secure). - -If that is not possible, try using the Windows Linux subsystem (WSL) - for which the Ubuntu instructions will work. -If you really want to install freqtrade natively on Windows, please follow the instructions below. - -All instructions assume that python 3.11+ is installed and available in your system PATH. - -!!! Note "Updating" - Keeping freqtrade updated is important to [ensure ongoing compatibility](updating.md#why-update) with exchange API's. - Please refer to the [updating guide](updating.md) for details on how to update your installation. - -## Clone the git repository - -First of all clone the repository by running: - -``` powershell -git clone https://github.com/freqtrade/freqtrade.git -``` - -Now, choose your installation method, either automatically via script (recommended) or manually following the corresponding instructions. - -## Install freqtrade automatically - -### Run the installation script - -The script will ask you a few questions to determine which parts should be installed. - -```powershell -Set-ExecutionPolicy -ExecutionPolicy Bypass -cd freqtrade -. .\setup.ps1 -``` - -## Install freqtrade manually - -!!! Note "64bit Python version" - Please make sure to use 64bit Windows and 64bit Python to avoid problems with backtesting or hyperopt due to the memory constraints 32bit applications have under Windows. - 32bit python versions are no longer supported under Windows. - -!!! Hint - Using the [Anaconda Distribution](https://www.anaconda.com/distribution/) under Windows can greatly help with installation problems. Check out the [Anaconda installation section](installation.md#installation-with-conda) in the documentation for more information. - -### Error during installation on Windows - -``` bash -error: Microsoft Visual C++ 14.0 is required. Get it with "Microsoft Visual C++ Build Tools": http://landinghub.visualstudio.com/visual-cpp-build-tools -``` - -Unfortunately, many packages requiring compilation don't provide a pre-built wheel. It is therefore mandatory to have a C/C++ compiler installed and available for your python environment to use. - -You can download the Visual C++ build tools from [here](https://visualstudio.microsoft.com/visual-cpp-build-tools/) and install "Desktop development with C++" in it's default configuration. Unfortunately, this is a heavy download / dependency so you might want to consider WSL2 or [docker compose](docker_quickstart.md) first. - -![Windows installation](assets/windows_install.png) - ---- diff --git a/mkdocs.yml b/mkdocs.yml index 681a892b2..cd658e54a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,9 +7,7 @@ use_directory_urls: True nav: - Home: index.md - Quickstart with Docker: docker_quickstart.md - - Installation: - - Linux/MacOS/Raspberry: installation.md - - Windows: windows_installation.md + - Installation: installation.md - Freqtrade Basics: bot-basics.md - Configuration: configuration.md - Strategy Quickstart: strategy-101.md