diff options
| author | a14m <[email protected]> | 2020-11-27 17:02:40 +0100 |
|---|---|---|
| committer | a14m <[email protected]> | 2020-11-27 17:55:36 +0100 |
| commit | 8185d66664367eab60edb3ab27103d22c1631769 (patch) | |
| tree | 6b2b8f68a3a559e8f24d65003ae17848e3111e5d /CLI/ruby/README.md | |
| parent | d1a020777af347f59b73b58f0ce96bb360dc6b35 (diff) | |
Initial commit of the ruby gem
Diffstat (limited to 'CLI/ruby/README.md')
| -rw-r--r-- | CLI/ruby/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/CLI/ruby/README.md b/CLI/ruby/README.md new file mode 100644 index 0000000..58d1cfd --- /dev/null +++ b/CLI/ruby/README.md @@ -0,0 +1,44 @@ +# 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 + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'game_of_life' +``` + +And then execute: + + $ bundle install + +Or install it yourself as: + + $ gem install game_of_life + +## Usage + +TODO: Write usage instructions here + +## 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 + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). + +## Code of Conduct + +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). |
