diff options
| author | Tom Black <[email protected]> | 2016-07-20 13:21:39 -0500 |
|---|---|---|
| committer | Tom Black <[email protected]> | 2016-07-20 13:21:39 -0500 |
| commit | a8e6bdbfee7a0477f70a3ea965c161b258869dbc (patch) | |
| tree | affcce72742c32732167a56a84dd18c26c6e041f /README.md | |
| parent | 8bbb2ed78234a5cd7f0647ab466ce68488398617 (diff) | |
| download | ruby2d-a8e6bdbfee7a0477f70a3ea965c161b258869dbc.tar.gz ruby2d-a8e6bdbfee7a0477f70a3ea965c161b258869dbc.zip | |
Update README
Add more badges, clean up some language.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -1,8 +1,8 @@ # Welcome to Ruby 2D! -[](https://travis-ci.org/ruby2d/ruby2d) +[](https://rubygems.org/gems/ruby2d) [](https://travis-ci.org/ruby2d/ruby2d) [](https://gitter.im/ruby2d/ruby2d) -This is the [Ruby 2D gem](https://rubygems.org/gems/ruby2d). Check out the [website](http://www.ruby2d.com) for help getting started, documentation, news, and more. See where we're headed in the [roadmap](http://www.ruby2d.com/roadmap) and learn about [contributing](http://www.ruby2d.com/contribute). If you encounter any issues, ping the [mailing list](https://groups.google.com/d/forum/ruby2d). +This is the [Ruby 2D gem](https://rubygems.org/gems/ruby2d). Check out the [website](http://www.ruby2d.com) for all things getting started, documentation, news, and more. The [roadmap](http://www.ruby2d.com/roadmap) will show you where we're headed, and if you're interested in getting involved in development, read the [contributor's guide](http://www.ruby2d.com/contribute). If you encounter any issues, [chat with us](https://gitter.im/ruby2d/ruby2d), send a note to the [mailing list](https://groups.google.com/d/forum/ruby2d), or open an issue. Enjoy! ## Development @@ -12,15 +12,15 @@ To work on the gem locally, first clone this repo with the test media [Git submo git clone --recursive https://github.com/ruby2d/ruby2d.git ``` -Along with cloning this repo, the above will grab the contents of the [`test_media`](https://github.com/simple2d/test_media) repo and place it in the `tests/media` directory. Simply run `git submodule update --remote` anytime to get the latest changes from `test_media` (i.e. when there's a new commit available). If you've already cloned this repo without the `--recursive` flag, make sure to run `git submodule init` before updating the submodule. +Along with cloning this repo, the command above will grab the contents of the [`test_media`](https://github.com/simple2d/test_media) repo and place it in the `tests/media` directory. Simply run `git submodule update --remote` anytime to get the latest changes from `test_media` (i.e. when there's a new commit available). If you've already cloned this repo without the `--recursive` flag, make sure to run `git submodule init` before updating the submodule. Next, install [Bundler](http://bundler.io) and run `bundle install` to get the required development gems. -Finally, install Simple 2D by following the instructions in the [README](https://github.com/simple2d/simple2d). +Finally, install Simple 2D by following the instructions in its [README](https://github.com/simple2d/simple2d). ## Tests -Ruby 2D uses a combination of automated tests via [RSpec](http://rspec.info) and manual, interactive tests to verify visual, audio, and input functionality. Build the gem and run all automated tests with `rake`. Run other tests using `rake <name_of_test>`, such as `rake testcard`. Run `rake -T` to see a list of all available tests. +Ruby 2D uses a combination of automated tests via [RSpec](http://rspec.info) and manual, interactive tests to verify the correctness of visual, audio, and input functionality. Build the gem and run all automated tests with the `rake` command. Run other tests using `rake <name_of_test>`, such as `rake testcard`. Use `rake -T` to see a list of all available tests. ## Preparing a Release |