diff options
Diffstat (limited to 'CLI/ruby/README.md')
| -rw-r--r-- | CLI/ruby/README.md | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/CLI/ruby/README.md b/CLI/ruby/README.md index 88dafcd..9ca42d3 100644 --- a/CLI/ruby/README.md +++ b/CLI/ruby/README.md @@ -41,25 +41,31 @@ Options: ## Development +### Locally - Clone the repo. - Navigate to the ruby CLI implementation `cd game-of-life/CLI/ruby`. - run `bundle install` to install dependencies. -- you can run `bundle rake build` to build the gem/CLI into the `pkg` directory. -- you can run `bundle rake install` to build and install gem/CLI into system gems. +- you can run `bundle exec rake build` to build the gem/CLI into the `pkg` directory. +- you can run `bundle exec rake install` to build and install gem/CLI into system gems. - you can run `bundle exec ./bin/game-of-life` to run the code for development/testing purposes +### Docker +- Run `docker build . -t ruby-gol` +- Run `docker run -it -v .:/app ruby-gol bundle exec rake install` +- Run `docker run -it ruby-gol` + ## Linting -Run `bundle exec rubocop` +Run `bundle exec rubocop` or `docker run -it -v .:/app ruby-gol bundle exec rubocop` ## Testing -Run `bundle exec rspec` +Run `bundle exec rspec` or `docker run -it ruby-gol bundle exec rspec` ## Documentation -Run `bundle exec yard` +Run `bundle exec yard` or `docker run -it -v .:/app ruby-gol bundle exec yard` ## Release -- Update the [version](./lib/game_of_live/version.rb) number -- Run `bundle install` and commit changes +- Update the [version](./game_of_life.gemspec#L5) number +- Run `bundle install` and commit changes (or `docker run -it -v .:/app ruby-gol bundle install`) - Update the [CHANGELOG](./CHANGELOG.md) - Create a git tag `ruby/v#{version_number}` ex: `ruby/v0.1.1-pre` |