diff options
| author | a14m <[email protected]> | 2020-11-27 18:30:46 +0100 |
|---|---|---|
| committer | a14m <[email protected]> | 2020-11-27 18:37:53 +0100 |
| commit | 6a5e959e6d0ac163e9ce1b3892141093e692623a (patch) | |
| tree | 3f997b2567dc22dfdeeddf8e30f464251f26a8ee /CLI/ruby/README.md | |
| parent | 8185d66664367eab60edb3ab27103d22c1631769 (diff) | |
Update the documentation for the ruby gem
Diffstat (limited to 'CLI/ruby/README.md')
| -rw-r--r-- | CLI/ruby/README.md | 45 |
1 files changed, 15 insertions, 30 deletions
diff --git a/CLI/ruby/README.md b/CLI/ruby/README.md index 58d1cfd..99bb57e 100644 --- a/CLI/ruby/README.md +++ b/CLI/ruby/README.md @@ -1,44 +1,29 @@ # GameOfLife -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/game_of_life`. To experiment with that code, run `bin/console` for an interactive prompt. - -TODO: Delete this and the text above, and describe your gem +The implementation of the [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) ruby CLI gem ## Installation - -Add this line to your application's Gemfile: - -```ruby -gem 'game_of_life' +```bash +$ gem install game_of_life ``` -And then execute: - - $ bundle install - -Or install it yourself as: - - $ gem install game_of_life - ## Usage -TODO: Write usage instructions here +Check `game-of-life --help` for usage info. ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). - -## Contributing - -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/game_of_life. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/game_of_life/blob/master/CODE_OF_CONDUCT.md). - - -## License +- Clone the repo. +- Navigate to the ruby CLI implementation `cd game-of-life/CLI/ruby`. +- run `bundle install` to install dependencies. +- 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. -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +## Testing -## Code of Conduct +Run `bundle exec rspec` or `bundle exec rake spec` -Everyone interacting in the GameOfLife project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/game_of_life/blob/master/CODE_OF_CONDUCT.md). +## Extra information +### [Contributing](../../CONTRIBUTING.md) +### [License](../../LICENSE.md) +### [Code of Conduct](../../CODE_OF_CONDUCT.md) |
