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 10:03:18 +00:00
parent ffad109aef
commit cc9f073d51
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -18,6 +18,8 @@ The build uses [CMake](https://cmake.org). Additionally, you need the following
- [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.
Note that the libraries are all FOSS software and GPL-compatible.
Now, building the project is quite easy:
```
cmake -DCMAKE_BUILD_TYPE=RELEASE . // Release build recommended for performance, unless you want to develop
@ -29,3 +31,7 @@ make // Rerun this every time you change source
# ./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.
## License
This is GPLv3-licensed. See [LICENSE](./LICENSE) for details.