diff --git a/README.md b/README.md index c2c6ad4..4390626 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,28 @@ cargo build -r ```sh cargo run -r ``` + +### Help +```s +Usage: rs48 [OPTIONS] + +Options: + -s, --size + size of the grid on which the game is played [default: 4] + -w, --spawn + number of tiles that will spawn on the grid each turn [default: 1] + --no-clear + disable clearing the terminal to refresh the screen + -k, --display-skips + skips the refresh of that many turns, allow AIs to play faster [default: 0] + -d, --delay + delay in ms to add between each turns [default: 0] + -c, --controller + the controller to use for the game [default: player] + --color-seed + sets a seed for the color pattern, 0 for random, default is 35 [default: 35] + -h, --help + Print help information + -V, --version + Print version information +``` \ No newline at end of file