Skip to content

Commit

Permalink
Update mac docs (#1083)
Browse files Browse the repository at this point in the history
* Separate Mac instructions

* Delete trailing whitespace

* Fix venv activation command

* Delete git from dependency installs

* Put next step link in Windows section
  • Loading branch information
MarkZH authored Jan 31, 2025
1 parent 367ca19 commit 587a60f
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions wiki/How-to-Install.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
### Mac/Linux
### Linux
- **NOTE: Only Python 3.9 or later is supported!**
- Download the repo into lichess-bot directory.
- Navigate to the directory in cmd/Terminal: `cd lichess-bot`.
- Install pip: `apt install python3-pip`.
- In non-Ubuntu distros, replace `apt` with the correct package manager (`pacman` in Arch, `dnf` in Fedora, `brew` in Mac, etc.), package name, and installation command.
- Install virtualenv: `apt install python3-virtualenv`.
- Setup virtualenv: `apt install python3-venv`.
- Install dependencies: `apt install python3 python3-pip python3-virtualenv python3-venv`.
- In non-Ubuntu linux distros, replace `apt` with the correct package manager (`pacman` in Arch, `dnf` in Fedora, etc.), package name, and installation command.
- Run the following commands to set up a virtual environment:
```
python3 -m venv venv # If this fails you probably need to add Python3 to your PATH.
virtualenv venv -p python3
Expand All @@ -16,6 +15,22 @@ python3 -m pip install -r requirements.txt

**Next step**: [Create a Lichess OAuth token](https://github.com/lichess-bot-devs/lichess-bot/wiki/How-to-create-a-Lichess-OAuth-token)

### Mac/BSD
- **NOTE: Only Python 3.9 or later is supported!**
- Install Python and other dependencies using the [homebrew package manager](https://brew.sh/):
- ` brew install python3 virtualenv # Net-/FreeBSD users might want to install: git, python311, py311-pip and py311-virtualenv.`
- Download the repo into lichess-bot directory.
- Navigate to the directory in cmd/Terminal: `cd lichess-bot`.
```
python3 -m venv venv # If this fails you probably need to add Python3 to your PATH.
virtualenv venv -p python3
. venv/bin/activate
python3 -m pip install -r requirements.txt
```
- Copy `config.yml.default` to `config.yml`.

**Next step**: [Create a Lichess OAuth token](https://github.com/lichess-bot-devs/lichess-bot/wiki/How-to-create-a-Lichess-OAuth-token)

### Windows
- **NOTE: Only Python 3.9 or later is supported!**
- If needed, install Python:
Expand All @@ -37,10 +52,12 @@ pip install -r requirements.txt
PowerShell note: If the `activate` command does not work in PowerShell, execute `Set-ExecutionPolicy RemoteSigned` first and choose `Y` there (you may need to run Powershell as administrator). After you execute the script, change execution policy back with `Set-ExecutionPolicy Restricted` and pressing `Y`.
- Copy `config.yml.default` to `config.yml`.

**Next step**: [Create a Lichess OAuth token](https://github.com/lichess-bot-devs/lichess-bot/wiki/How-to-create-a-Lichess-OAuth-token)

### Docker
If you have a [Docker](https://www.docker.com/) host, you can use the ```lichess-bot-devs/lichess-bot``` [image in DockerHub](https://hub.docker.com/r/lichessbotdevs/lichess-bot).
If you have a [Docker](https://www.docker.com/) host, you can use the ```lichess-bot-devs/lichess-bot``` [image in DockerHub](https://hub.docker.com/r/lichessbotdevs/lichess-bot).
It requires a folder where you have to copy `config.yml.default` to `config.yml`.

See [Running with Docker](https://github.com/lichess-bot-devs/lichess-bot/wiki/How-to-use-the-Docker-image) once you've created the OAuth token and setup the engine.
See [Running with Docker](https://github.com/lichess-bot-devs/lichess-bot/wiki/How-to-use-the-Docker-image) once you've created the OAuth token and setup the engine.

**Next step**: [Create a Lichess OAuth token](https://github.com/lichess-bot-devs/lichess-bot/wiki/How-to-create-a-Lichess-OAuth-token)

0 comments on commit 587a60f

Please sign in to comment.