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

Update README.md

Browse source
This commit is contained in:
Maximilian Keßler 2023-08-12 09:52:17 +00:00
parent 46554a7e33
commit ffad109aef
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -12,4 +12,20 @@ For example, if the output of the program is 1, then this means that even if an
## Compilation
The build uses cmake. Additionally, you need the [boost](https://www.boost.org) and [cpr](https://libcpr.org) libraries to build, refer to these pages to install them.
The build uses [CMake](https://cmake.org). Additionally, you need the following libraries:
- [boost](https://www.boost.org): For some faster containers and JSON parsing
- [cpr](https://libcpr.org): For easy requests (to download games from [hanab.live](https://hanab.live)
- [GNU readline](https://tiswww.cwru.edu/php/chet/readline/rltop.html): For the comman-line interface
Refer to the corresponding pages for installation instructions. On Linux distributions, readline is probably already installed.
Now, building the project is quite easy:
```
cmake -DCMAKE_BUILD_TYPE=RELEASE . // Release build recommended for performance, unless you want to develop
make // Rerun this every time you change sources
```
## Usage
```
# ./endgame-analyzer (GAME_ID | GAME_FILE) TURN
```
where `GAME_ID` is a game from hanab.live and `GAME_FILE` is a path to a file containing the game as JSON in the hanab.live format.