From 8cfd9ebd19def50ced9300a550fb43e1bf26d399 Mon Sep 17 00:00:00 2001 From: Peter Cottle Date: Wed, 20 Feb 2013 20:56:22 -0800 Subject: [PATCH] readme --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ff713a7..0be4bb0c 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,17 @@ You can build levels with `build level`. The dialog should walk you through the ### Contributing Levels -I would love for more levels to be added! I think there is a ton to learn and cover. Hopefully the community together can build a great tool for all git newcomers. +I would love for more levels to be added! I think there is a ton to learn and cover. Hopefully the community together can build a great tool for all git newcomers. You can make your own levels with -## Contributing +``` +build level +``` -I am really loose about contributing levels. For contributing functionality, you will need to install the `grunt` build tool. The general steps: +In the application. You will be walked through the process, and at the end you can `export level` to get a JSON blob. Paste that in a gist or directly into an issue and I can check it out / merge in your changes! + +## Contributing Functionality + +For contributing core functionality in the app, you will need to install the `grunt` build tool. The general steps: ``` git clone @@ -38,6 +44,9 @@ cd learnGitBranching npm install git checkout -b newAwesomeFeature # some changes +grunt build # now you can open up your browser to the index.html and see your changes +grunt watch # will keep watch over files and fastBuild whenever they change +# more changes grunt build git commit -am "My new sweet feature!" git push