diff options
| author | a14m <[email protected]> | 2020-12-03 15:32:56 +0100 |
|---|---|---|
| committer | a14m <[email protected]> | 2020-12-03 15:32:56 +0100 |
| commit | c51d433f682467f52f4f160aaa324224eb82285b (patch) | |
| tree | 488005a6b50faf12e4d2484f684ecbe7bcd93290 /CLI/ruby/README.md | |
| parent | 94a9071fc00d6c14c359d31f7b576f9257d51219 (diff) | |
Update the documentation
Diffstat (limited to 'CLI/ruby/README.md')
| -rw-r--r-- | CLI/ruby/README.md | 25 |
1 files changed, 24 insertions, 1 deletions
diff --git a/CLI/ruby/README.md b/CLI/ruby/README.md index 99bb57e..50058d1 100644 --- a/CLI/ruby/README.md +++ b/CLI/ruby/README.md @@ -11,6 +11,24 @@ $ gem install game_of_life Check `game-of-life --help` for usage info. +``` + game-of-life --version, -v # Prints the Game of Life version information + game-of-life help [COMMAND] # Describe available commands or one specific command + game-of-life start [OPTIONS] # Start the Game of Life simulations (default command) + +Options: + -s, [--seed=SEED] # Specify the seed number to use as an initial state (default to random). + -i, [--input=VALUE] # Specify the path/URL for the file to use as an initial state. (used instead of seed) + -w, [--width=WIDTH] # Specify the width of generated universe. (default to terminal width) + -h, [--height=HEIGHT] # Specify the hight of generated universe. (default to terminal height) + [--dead-cell=CHAR] # Specify the dead-cell representation + # Default: + [--live-cell=CHAR] # Specify the dead-cell representation + # Default: █ + -d, [--delay=Milli-Seconds] # Specify the introduced delay between each generation + # Default: 50 +``` + ## Development - Clone the repo. @@ -19,10 +37,15 @@ Check `game-of-life --help` for usage info. - run `bundle rake build` to build the gem/CLI into the `pkg` directory. - run `bundle rake install` to build and install gem/CLI into system gems. -## Testing +## Linting +Run `bundle exec rubocop` +## Testing Run `bundle exec rspec` or `bundle exec rake spec` +## Documentation +Run `bundle exec yard` + ## Extra information ### [Contributing](../../CONTRIBUTING.md) ### [License](../../LICENSE.md) |