Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Bench: 1540328
  • Loading branch information
codedeliveryservice committed May 3, 2024
1 parent 7aa8fef commit 95851ba
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,21 +121,26 @@ For detailed information on the specific features needed for each level, refer t
To build the engine from source, make sure you have `Rust 1.65` or a later version installed.
If you don't have Rust, follow the [official Rust installation guide](https://www.rust-lang.org/tools/install).

Then, compile the engine using `Cargo`:
The source code doesn't include an NNUE model to keep the repository lightweight. Instead,
models are stored in the [Reckless Networks][reckless-networks] repository.

```bash
cargo rustc --release -- -C target-cpu=native
```
You can download the latest model using the `fetch-nnue.sh` (or `fetch-nnue.ps1` on Windows) script,
which will be placed in the `networks` directory and automatically detected during the build.

Alternatively, you can use the provided `Makefile`:
Alternatively, you can specify the path to the model file using the `EVALFILE` variable:

```bash
# Build for the current CPU architecture
# Build the engine with a `./networks/model.nnue` model
make
# Build release binaries for all microarchitecture levels
make release

# Build the engine with a specific model
make EVALFILE=networks/model.nnue
```

Keep in mind that older models may be incompatible with the current version of the engine.

[reckless-networks]: https://github.com/codedeliveryservice/RecklessNetworks

### Usage

Reckless is not a standalone chess program but a chess engine designed for use with UCI-compatible GUIs,
Expand Down

0 comments on commit 95851ba

Please sign in to comment.