summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorTom Black <[email protected]>2016-04-19 23:16:38 -0400
committerTom Black <[email protected]>2016-04-19 23:16:38 -0400
commit0f49b20758e92d2c1be803a50d439a16ba9d2f43 (patch)
tree5a5abe9f6ade39b3f66ef319b47b8068b9437f8b /README.md
parent3341f29e4e3e6f470534bf5843863138bd3a1778 (diff)
downloadruby2d-0f49b20758e92d2c1be803a50d439a16ba9d2f43.tar.gz
ruby2d-0f49b20758e92d2c1be803a50d439a16ba9d2f43.zip
Adding much needed clarity to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 15 insertions, 22 deletions
diff --git a/README.md b/README.md
index 9ec226f..fe62ffe 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,29 @@
# Welcome to Ruby 2D!
-This is the Ruby 2D gem. [Check out the website](http://www.ruby2d.com) for help getting started, documentation, news, and more.
+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).
-## Running Tests
+## Development
-Ruby 2D uses both RSpec and custom tests. Run `bundle install` to get all development dependences.
-
-### Getting the Test Media
-
-To keep the size of this repository small, media needed for tests are checked into the Simple 2D [`test_media`](https://github.com/simple2d/test_media) repo and referenced as a [Git submodule](http://git-scm.com/book/en/v2/Git-Tools-Submodules). After cloning this repo, init the submodule and get its contents by using:
-
-```bash
-git submodule init
-git submodule update --remote
-```
-
-Alternatively, you can clone the repo and update the submodule in one step:
+To work on the gem locally, first clone this repo with the test media [Git submodule](http://git-scm.com/book/en/v2/Git-Tools-Submodules):
```bash
git clone --recursive https://github.com/ruby2d/ruby2d.git
```
-Simply run `git submodule update --remote` anytime to get the latest changes from `test_media` (i.e. when there's a new commit available).
+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.
-### Available Tests
+Next, install [Bundler](http://bundler.io) and run `bundle install` to get the required development gems.
-The current tests available are:
+Finally, install Simple 2D by following the instructions in the [README](https://github.com/simple2d/simple2d).
-- [`testcard.rb`](tests/testcard.rb) – A graphical card, similar to [testcards from TV](http://en.wikipedia.org/wiki/Testcard), with the goal of making sure all visual and inputs are working properly.
+## Tests
-Run a test using `rake <name_of_test>`, for example:
+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.
-```bash
-rake testcard
-```
+## Preparing a Release
+
+1. Update the minimum Simple 2D version required in [extconf.rb](ext/ruby2d/extconf.rb)
+2. Run tests on all supported platforms
+3. Update the version number in [`version.rb`](lib/ruby2d/version.rb), commit changes
+4. Create a [new release](https://github.com/ruby2d/ruby2d/releases) in GitHub, with tag in the form `v#.#.#`
+5. Push to [rubygems.org](rubygems.org) with `gem push ruby2d-#.#.#.gem`