From dc340b2447f8029ef28e1fe3d39cbee8ca0e1d14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= Date: Wed, 6 Sep 2023 12:02:08 +0200 Subject: [PATCH] better usage --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 00b0267..dd5fa42 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,14 @@ 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. +where +- `GAME_ID` is a game from hanab.live. +- `GAME_FILE` is a path to a file containing the game as JSON in the hanab.live format. +- `TURN` specifies the turn of the game state to analyze. Turn 1 is the state before actions have been taken. + +Be cautious about specifying too low turn counts, your program will eventually run out of memory. +Typically, turn counts where roughly 8 cards are still in the draw pile are reasonably fast, +but running times depend heavily on the exact game state you want to analyze. ## License