Skip to content

Commit

Permalink
Update installation and build instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
bsamseth committed Sep 16, 2024
1 parent 364a439 commit 8b171b3
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,16 +126,19 @@ Detailed head-to-head statistics can be found [here](stats/head-to-head-history.

## Installation

Each release comes with pre-compiled executables for Linux and Windows. Just download these and run them in your GUI of
choice.
Some releases have pre-compiled executables for Linux and Windows. If
available, download these and run them in your GUI of choice. Note that the
pre-compiled binaries won't necessarily be optimized for your CPU, and you
might get abou 5% better performance by compiling the engine yourself, see
below.

## Build

Requires a recent Rust toolchain, with no particular MSRV. Get the latest stable version from [rustup](https://rustup.rs/).

``` bash
cd src
cargo build --profile release-lto --package engine
cargo build --profile release-lto --bin goldfish
```

This resulting executable will be in `src/target/release-lto/goldfish[.exe]`.
This resulting executable will be in `target/release-lto/goldfish[.exe]`.

0 comments on commit 8b171b3

Please sign in to comment.