Hanabi/Endgame-Analyzer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update README

Browse source
This commit is contained in:
Maximilian Keßler 2024-06-17 20:55:24 +02:00
parent 1a2824453f
commit a1c3b3f8ef
Signed by: max
GPG key ID: BCC5A619923C0BA5
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -32,9 +32,11 @@ I can't provide information for all distributions, but in general it should be l
**Linux systems**:
- `boost` and `cmake`: should be available as a system package via your package manager.
- `readline` should be installed already, otherwise try your package manager as well. On some systems, you will need to additionally install `libreadline-dev` (or similar),
- `cpr` should be fetched as a submodule from its GitHub repository automatically by CMake
- Alternatively, install cpr globally via your package manager. For example, this is possible for Arch via [AUR](https://aur.archlinux.org/packages/cpr) and Fedora via [rpm](https://src.fedoraproject.org/rpms/cpr)
- Unfortunately, on many Debian-derivatives, only boost 1.71 is available with your system repositories. To compile this project, you need boost>=1.75.
- As an alternative, you can compile boost from source, refer to the [Boost Unix installation guide][boost-installation]. You will need to link against boost binary libraries as well (see section 5), specifically the 'Program Options' (and optionally 'Unit Test' if you want to compile them). For this, you can use `./bootstrap.sh --with-libraries=program_options` (or `--with-libraries=program_options,test`) to limit compilation of the boost libraries to only those you need. To install boost globally, run `sudo ./b2 install`, otherwise you will need to point CMake to your local installation and edit `CMakeLists.txt` acoordingly.
- `readline` should be installed already, otherwise try your package manager as well. On some systems, you will need to additionally install `libreadline-dev` (or similar), since this includes the development headers needed for linking during compilation.
- `cpr` should be fetched as a submodule from its GitHub repository automatically by CMake.
- Alternatively, install cpr globally via your package manager (and edit `CMakeList.txt` accordingly to use `find_package`). For example, this is possible for Arch via [AUR](https://aur.archlinux.org/packages/cpr) and Fedora via [rpm](https://src.fedoraproject.org/rpms/cpr)
**Mac OS**:
- I recommend installing packages with [Homebrew](https://brew.sh).
@ -43,6 +45,7 @@ I can't provide information for all distributions, but in general it should be l
**Windows**:
- I recommend using the 'Windows Subsystem for Linux (WSL)'. Then, follow the Linux system installation from above.
- WSL is the (currently) only tested installation method for Windows.
### Installing cpr as a local CMake dependency
- There is also the option to install `cpr` directly as a dependency through `CMake`.
@ -77,3 +80,6 @@ but running times depend heavily on the exact game state you want to analyze.
## License
This is GPLv3-licensed. See [LICENSE](./LICENSE) for details.
[boost-installation]: https://www.boost.org/doc/libs/1_85_0/more/getting_started/unix-variants.html