further readme cleanup

This commit is contained in:
Maximilian Keßler 2023-09-22 19:00:57 +02:00
parent f1e415241a
commit 4adb835e7e
Signed by: max
GPG key ID: BCC5A619923C0BA5

View file

@ -30,7 +30,7 @@ make // Rerun this every time you change source
### Installing the libraries
I can't provide information for all distributions, but in general it should be like the following:
Linux systems:
**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.
- `cpr` is a bit more complicated:
@ -39,11 +39,11 @@ Linux systems:
- There might be packages for other distributions, check out the [CPR project on Github](https://github.com/libcpr/cpr#packages-for-linux-distributions).
- If there is no package available for your distribution, see [below](# Installing cpr as a local CMAKE dependency)
Mac OS:
**Mac OS**:
- I recommend installing packages with [Homebrew](https://brew.sh).
- So `brew install boost cpr readline cmake` should do the job.
Windows:
**Windows**:
- Currently, I have no idea regarding windows, sorry for that.
### Installing cpr as a local CMAKE dependency
@ -59,10 +59,10 @@ Windows:
GIT_TAG 2553fc41450301cd09a9271c8d2c3e0cf3546b73)
FetchContent_MakeAvailable(cpr)
```
where you replace the git tag with the latest release tag from [Github](https://github.com/libcpr/cpr/releases).
You might need to replace the `GIT_TAG` with the latest release tag from [Github](https://github.com/libcpr/cpr/releases),
but the above should usually work.
You can find details on this installation method on the [cpr github page](https://github.com/lipcpr/cpr) as well.
## Usage
```
# ./endgame-analyzer (GAME_ID | GAME_FILE) TURN