Skip to content

Commit 0ca146d

Browse files
committed
Fix installation process and versions
1 parent 961473d commit 0ca146d

File tree

1 file changed

+13
-25
lines changed

1 file changed

+13
-25
lines changed

README.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,27 @@ Currently, the following platforms are under development:
2020
| USB | x | x | x | x |
2121
| Bluetooth LE | x | x | |
2222

23-
## Alpha installation instructions
23+
## Installation instructions
2424

25-
This project is under heavy development, and basically everything described below might change at some point.
26-
27-
### Dependencies
28-
29-
`python-mchess` is written for Python >= 3.7.
30-
If UCI-engine support (python-chess dependency) is not used, any Python 3.x works. (python-mchess makes use of latest async features of Python 3.7 and later)
31-
32-
`python-mchess` board driver for Chess Link depends on `PySerial` and (Linux/Raspberry Pi only) `BluePy`
33-
34-
#### Optional UCI engine support
35-
36-
In order to use UCI engines with mchess, additionally `python-chess` is used, the Tkinter-GUI prototype uses `Pillow`.
37-
38-
```bash
39-
pip3 install pyserial [bluepy] [python-chess] [Pillow]
40-
```
41-
42-
Then clone the repository
25+
The project requires Python 3.7 and later (tested with 3.11). Please use a Python virtual environment to install the dependencies:
4326

4427
```bash
4528
git clone https://github.com/domschl/python-mchess
29+
cd python-mchess
30+
# In folder python-mchess:
31+
python -m venv mchess
32+
cd mchess
33+
source bin/activate
34+
# Now install dependencies:
35+
python -m pip install -r requirements.txt
36+
# On Linux, install bluepy, skip for macOS and Windows:
37+
python -m pip install bluepy
4638
```
4739

4840
Now configure some engines:
4941

5042
```bash
43+
# In folder python-mchess:
5144
cd mchess/engines
5245
```
5346

@@ -68,15 +61,10 @@ Note: Windows users need to use paths with `\\` or `/` for proper json encoding.
6861

6962
#### Web client
7063

71-
The web agent requires python modules `Flask`, `Flask-Sockets` and `gevent`.
72-
73-
```bash
74-
pip3 install flask flask-sockets gevent
75-
```
76-
7764
Node JS packet manager `npm` is needed to install the javascript dependencies:
7865

7966
```bash
67+
# In folder python-mchess:
8068
cd mchess/web
8169
npm install
8270
```

0 commit comments

Comments
 (0)