From cc9f073d5182ede9031149308f78eaa8b29e8550 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Sat, 12 Aug 2023 10:03:18 +0000 Subject: [PATCH] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index af04e80..1f53ff2 100644 --- a/README.md +++ b/README.md @@ -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.