Skip to content

Commit 7a4d244

Browse files
committed
Create separate instructions for dev dependencies
1 parent ac5cd33 commit 7a4d244

1 file changed

Lines changed: 21 additions & 16 deletions

File tree

README.rst

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,32 +17,37 @@ Installation
1717

1818
pip3 install chess-annotator
1919

20-
If you clone this repository, you will have to update the eco submodule, since
21-
a clone does not do this automatically:
22-
23-
::
24-
25-
git clone --recurse-submodules git@github.com:rpdelaney/python-chess-annotator.git
26-
2720
Dependencies
2821
------------
2922

30-
You will need a UCI[`1 <https://chessprogramming.wikispaces.com/UCI>`__]
23+
You will need a `UCI <https://chessprogramming.wikispaces.com/UCI>`_
3124
chess engine for analysis.
32-
stockfish[`2 <https://stockfishchess.org/download/>`__] is the default.
25+
`stockfish <https://stockfishchess.org/download/>`_ is the default.
26+
27+
Any of the `variants supported by python-chess <https://python-chess.readthedocs.io/en/v0.27.3/variant.html>`_ should work.
28+
You will need a UCI engine that supports the variant you are trying to analyze.
29+
`Daniel Dugovic's stockfish fork <https://github.com/ddugovic/Stockfish>`_
30+
supports most of the popular variants.
3331

34-
Requires python-chess[`3 <https://github.com/niklasf/python-chess>`__]
35-
by Niklas Fiekas:
32+
============
33+
Development
34+
============
35+
36+
If you clone this repository, you will have to update the eco submodule, since
37+
git clone does not do this by default:
3638

3739
::
3840

39-
pip3 install python-chess
41+
git clone --recurse-submodules git@github.com:rpdelaney/python-chess-annotator.git
4042

4143

42-
Any of the variants supported by python-chess should work.[`4 <https://python-chess.readthedocs.io/en/v0.27.3/variant.html>`__]
43-
You will need a UCI engine that supports the variant you are trying to analyze.
44-
Daniel Dugovic's stockfish fork[`5 <https://github.com/ddugovic/Stockfish>`__]
45-
supports most of the popular variants.
44+
To install development dependencies, you will need `pipenv <https://docs.pipenv.org/en/latest/>`_
45+
and `pre-commit <https://pre-commit.com/>`_.
46+
47+
::
48+
49+
pipenv sync --dev
50+
pre-commit install --install-hooks
4651

4752
Usage
4853
-----

0 commit comments

Comments
 (0)