Skip to content

Commit

Permalink
Add installation instructions for Windows OS
Browse files Browse the repository at this point in the history
  • Loading branch information
kiudee committed Feb 19, 2022
1 parent a7ed5eb commit 2a074dd
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@

.. image:: https://raw.githubusercontent.com/kiudee/chess-tuning-tools/master/docs/_static/CTT-Plots.png

.. raw:: html

<img src="https://raw.githubusercontent.com/kiudee/chess-tuning-tools/master/docs/_static/logo.png" align="right">

.. image:: https://readthedocs.org/projects/chess-tuning-tools/badge/?version=latest&style=flat-square
:target: https://chess-tuning-tools.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://zenodo.org/badge/234719111.svg?style=flat-square
:target: https://zenodo.org/badge/latestdoi/234719111

Expand Down Expand Up @@ -47,6 +47,16 @@ To execute the local tuner, simply run::
Take a look at the `usage instructions`_ and the `example configurations`_ to
learn how to set up the ``tuning_config.json`` file.

Installation on Windows
^^^^^^^^^^^^^^^^^^^^^^^

To get chess-tuning-tools to work on Windows, the easiest way is to install
the `Miniconda <https://www.continuum.io/downloads>`_ distribution.
Then, create a new environment and install chess-tuning-tools::

conda create -n myenv python=3.9 scikit-learn=0.23
activate myenv
pip install chess-tuning-tools

.. _example configurations: https://github.com/kiudee/chess-tuning-tools/tree/master/examples
.. _usage instructions: https://chess-tuning-tools.readthedocs.io/en/latest/usage.html
11 changes: 11 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ This is the preferred method to install Chess Tuning Tools, as it will always in
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

Installation on Windows
^^^^^^^^^^^^^^^^^^^^^^^

To get chess-tuning-tools to work on Windows, the easiest way is to install
the `Miniconda <https://www.continuum.io/downloads>`_ distribution.
Then, create a new environment and install chess-tuning-tools::

conda create -n myenv python=3.9 scikit-learn=0.23
activate myenv
pip install chess-tuning-tools

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/

Expand Down

0 comments on commit 2a074dd

Please sign in to comment.