diff --git a/README.md b/README.md index 1e2c94aa..a5f02b70 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,36 @@ LearnGitBranching is a pseudo-git sandbox and interactive series of tutorials / ### Sandbox Mode +Sandbox mode is where you can mess around and just see what certain git commands do. It is moderately helpful, but the real magic lies in levels... + ## Levels +Type `levels` to see the available levels. These are a mix of tutorials and challenges to introduce git concepts and get newcomers familiar with certain workflows. There is also a "git golf" concept that tracks how many commands you used to solve the level :P + ### Level Builder +You can build levels with `build level`. The dialog should walk you through the majority of the commands -- at the end you will get a JSON blob that you can share with friends or paste into a github issue. + ### Contributing Levels +I would love for more levels to be added! I think there is a ton to learn and a ton to cover. Hopefully the community together can build a great tool for all git newcomers. + ## Contributing +I really loose about contributing levels. For contributing functionality, you will need to install the `grunt` build tool. The general steps: + +``` +git clone +cd learnGitBranching +npm install +git checkout -b newAwesomeFeature +# some changes +grunt build +git commit -am "My new sweet feature!" +git push +# go online and request a pull +``` + ## Helpful Folks A big shoutout to these brave souls for extensively testing our sandbox and finding bugs and/or inconsistencies: