From 10624320f3462434453a4beb9b7c183ee2120f30 Mon Sep 17 00:00:00 2001 From: Derek Neighbors Date: Sat, 2 Feb 2019 15:35:33 -0700 Subject: [PATCH] Add missing documentation to get test suite running and sample game installed --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5aeb032..25bc27f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.