diff options
| author | Tom Black <[email protected]> | 2017-02-22 01:32:05 -0500 |
|---|---|---|
| committer | Tom Black <[email protected]> | 2017-02-22 01:32:05 -0500 |
| commit | bd349170ddf4e8506098a2c58a1347452288a462 (patch) | |
| tree | 283312d4791cd83eacc6cd974040ab03deeeaee1 /README.md | |
| parent | 00106fa93735241959fb0e7e75c4d3c3c0475f25 (diff) | |
| download | ruby2d-bd349170ddf4e8506098a2c58a1347452288a462.tar.gz ruby2d-bd349170ddf4e8506098a2c58a1347452288a462.zip | |
Update README
Note that the gem is still in development, fix broken links, improve
instructions.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 5 insertions, 7 deletions
@@ -1,8 +1,8 @@ # Welcome to Ruby 2D! -[](https://rubygems.org/gems/ruby2d) [](https://travis-ci.org/ruby2d/ruby2d) [](https://gitter.im/ruby2d/ruby2d) +[](https://rubygems.org/gems/ruby2d) [](https://travis-ci.org/ruby2d/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! +This is the [Ruby 2D gem](https://rubygems.org/gems/ruby2d). It's still under development, but [check out the website](http://www.ruby2d.com) to preview the documentation. ## Development @@ -12,15 +12,13 @@ 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 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. +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 `test/media` directory, and [assets](https://github.com/ruby2d/assets) used by the gem. 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 its [README](https://github.com/simple2d/simple2d). +Next, install [Bundler](http://bundler.io) and run `bundle install` to get the required development gems. Install the native graphics library [Simple 2D]((https://github.com/simple2d/simple2d)) by following the instructions in its README. Finally, run `rake` to build and install the gem locally. ## 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. +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 the interactive tests in the [`test/`](test/) directory using `rake test <name_of_test>`, such as `rake test testcard`. To run the test as a native or web application, use `rake native <name_of_test>` and `rake web <name_of_test>`, respectfully. ## Preparing a Release |
