added help in readme
This commit is contained in:
parent
9c253d36df
commit
612127db19
1 changed files with 25 additions and 0 deletions
25
README.md
25
README.md
|
@ -29,3 +29,28 @@ cargo build -r
|
|||
```sh
|
||||
cargo run -r
|
||||
```
|
||||
|
||||
### Help
|
||||
```s
|
||||
Usage: rs48 [OPTIONS]
|
||||
|
||||
Options:
|
||||
-s, --size <SIZE>
|
||||
size of the grid on which the game is played [default: 4]
|
||||
-w, --spawn <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 <DISPLAY_SKIPS>
|
||||
skips the refresh of that many turns, allow AIs to play faster [default: 0]
|
||||
-d, --delay <DELAY>
|
||||
delay in ms to add between each turns [default: 0]
|
||||
-c, --controller <CONTROLLER>
|
||||
the controller to use for the game [default: player]
|
||||
--color-seed <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
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue