blob: 9ec226fe0708eb606a1370e68e2f8452e3a98ada (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
# 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.
## Running Tests
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:
```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).
### Available Tests
The current tests available are:
- [`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.
Run a test using `rake <name_of_test>`, for example:
```bash
rake testcard
```
|
