Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing documentation to get test suite running and sample game installed. #142

Closed
wants to merge 1 commit into from
Closed

Add missing documentation to get test suite running and sample game installed. #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,18 @@ Keep the documentation up-to-date. Use the style present throughout the codebase
## Pull Requests

Ensure that all of your code includes the commits from the `master` branch. Run the `rspec` command in the top-level directory to verify that all tests are passing. You will make your pull request to the branch specified in the issue tracker. If no branch has been mentioned, please write a comment on the appropriate issue, and we will follow up shortly.

## Getting Started
Install dependencies. Rebuild goby gem. Run test suite.
```
bundle install
./script/reinstall.sh
rspec
```
## Create Test Game
Run the goby binary in an empty directory for your game. Then execute the main loop to start playing.
```
goby
ruby goby-project/src/main.rb
```
See the tutorial/ directory for building your own game with goby.