Permalink
Browse files

update README

  • Loading branch information...
1 parent befaaf7 commit 2f99b4c12c33d7645e0e5e08bf272c6868b3ec7b @avalanche123 committed Jun 2, 2011
Showing with 6 additions and 5 deletions.
  1. +6 −5 README.md
View
@@ -1,11 +1,12 @@
-== Mastermind
+Mastermind
+==========
The game of mastermind in Rails
This is a test project to familiarize myself with RSpec and Cucumber
The whole game is completely unit and functionally tested
The specs and features can be found under `/spec` and `/features` accordingly
-== Rules
+##Rules
* To play the game, you will have to register and log in
* To start a game, you will need to click "Play" from your dashboard
@@ -17,18 +18,18 @@ The specs and features can be found under `/spec` and `/features` accordingly
* When you guessed all pegs, the game is over and you won
* After 8 unsuccessful attempts, the game is over and you lost
-== Installation
+## Installation
* Clone the repository
* In the repository root, run `bundle install`
* Create the database by running `rake db:migrate`
-== Running tests
+## Running tests
* Run `rake spec` to run specs
* Run 'rake cucumber` to run features
-== Starting the game
+## Starting the game
* Run `rails server`
* Go to `localhost:3000` and follow game's instructions

0 comments on commit 2f99b4c

Please sign in to comment.