diff --git a/documentation/src/install.rst b/documentation/src/install.rst index 070f232..f1d7fcb 100644 --- a/documentation/src/install.rst +++ b/documentation/src/install.rst @@ -94,3 +94,41 @@ Getting the Inkscape plugins to run will likely need manual installation (see above). Note that Inkscape may come with its own Python. If you run into trouble or have better installation instructions please open a ticket on GitHub. + +Following steps are known to work under Windows 10 (64-bit): + +1. Go to https://www.python.org/downloads/windows/ + and download the "Windows x86-64 executable installer" for Python 3.7 +2. Install Python 3.7 and make sure to check "Add Python 3.7 to PATH" + while doing so +3. Go to https://www.lfd.uci.edu/~gohlke/pythonlibs/#cairocffi + and download :code:`cairocffi‑1.0.2‑cp37‑cp37m‑win_amd64.whl` +4. Go to https://www.lfd.uci.edu/~gohlke/pythonlibs/#pycairo + and download `pycairo‑1.18.0‑cp37‑cp37m‑win_amd64.whl` +5. Open the Command Prompt + (i.e. via the shortcut Windows + R and then typing "cmd" + and pressing Enter) +6. Change to the folder where the .whl files from step 3 and 4 are located + (e.g. with the command :code:`cd \Users\[USERNAME]\Downloads` + where `[USERNAME]` is your username and `Downloads` the folder where + the .whl files are located) +7. Run the command :code:`pip install cairocffi‑1.0.2‑cp37‑cp37m‑win_amd64.whl + pycairo‑1.18.0‑cp37‑cp37m‑win_amd64.whl Markdown lxml` + (Note: If the command pip is not found, you probably forgot to add the + Python installation to the PATH environment variable in step 2) +8. Download Boxes.py as ZIP archive from GitHub +9. Extract the ZIP archive + (e.g. via the built-in Windows feature or other tools like 7-Zip) +10. Change into the folder for Boxes.py, + e.g. with the command :code:`cd \Users\[USERNAME]\Downloads\boxes-master` +11. Run the development server with the command + :code:`python scripts\boxesserver` +12. Open the address http://localhost:8000/ in your browser and have fun :) + +Alternatively the command line version of Boxes.py can be used with +the command :code:`python scripts\boxes`. + +Another way of installing Boxes.py on Windows is to use the Windows Subsystem +for Linux (WSL). This requires newer versions of Windows 10. Once it is +installed (e.g. via the Ubuntu App from the Microsoft Store), the installation +is identical to the installation on Linux systems.