Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Gary Rennie committed Mar 22, 2012
1 parent be5c11e commit 471c1d5
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
#Githug
# Githug
Git Your Game On [![Build Status](https://secure.travis-ci.org/Gazler/githug.png?branch=master)](http://travis-ci.org/Gazler/githug)

##About
## About
Githug is designed to give you a practical way of learning git. It has a series of levels, each utilizing git commands to ensure a correct answer.

##Installation
## Installation
To install Githug

gem install githug

After the gem is installed, you can run `githug` where you will be prompted to create a directory. Githug should work on Linux and OS X.

##Commands
## Commands

Githug has 4 commands:

Expand All @@ -21,7 +21,7 @@ Githug has 4 commands:
* test - Used to test levels in development, please see the Testing Levels section.


##Contributing
## Contributing

If you want to suggest a level or make a level that has been suggested, check out [the wiki](https://github.com/Gazler/githug/wiki).

Expand All @@ -33,14 +33,14 @@ If you want to suggest a level or make a level that has been suggested, check ou
* Make sure your level works (covered below)
* Submit a pull request

##Todo List
## Todo List

* A better way of returning from the solution block
* A follow up to the level, more information on a specific command, etc.
* More levels!
* [Windows support](https://github.com/Gazler/githug/wiki/Windows-Support)

##Writing Levels
## Writing Levels

Githug has a DSL for writing levels

Expand Down Expand Up @@ -106,7 +106,7 @@ This will copy the contents of a repository specified in the levels folder for y

After doing this, your level should be able to copy the contents from that git repository and use those for your level. You can see the "blame" level for an example of this.

##Testing Levels
## Testing Levels

The easiest way to test a level is:

Expand Down

0 comments on commit 471c1d5

Please sign in to comment.