diff --git a/README.md b/README.md index b0cdc8a..af04e80 100644 --- a/README.md +++ b/README.md @@ -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.