Permalink
Browse files

Updated the README to include a simple setup guide. :)

  • Loading branch information...
1 parent d1bb5ce commit 43032fe7af231523b17fe6b81e38bea12ee5c426 @fredwu committed Aug 17, 2011
Showing with 15 additions and 1 deletion.
  1. +15 −1 README.md
View
@@ -22,7 +22,7 @@ Probably no, but if you think this system could be used for something else, and
Well duh. I have my day job as well as my own adventure to worry about on top of this stressful project, so please cut me some slack. ;)
-## System
+## System Info
### Stack
@@ -43,6 +43,20 @@ Well duh. I have my day job as well as my own adventure to worry about on top of
In order to keep DB migration to minimum, migration files are modified during the development. Please run `rake dev:db:reset` to keep your database schema up to date.
+## Setup Guide
+
+In order to run the system (for demo and development purposes), you may follow the following steps:
+
+- clone the repo, obviously
+- if you use [RVM](http://beginrescueend.com/), you may rename the `_rvmrc` file to `.rvmrc` and adjust its content accordingly
+- copy or rename `config/database.example.yml` to `config/database.yml` and adjust its content accordingly
+- `bundle install`
+- `rake db:create`
+- `rake dev:db:reset`
+- `rails s`
+- done, fire up your browser and browse to `http://localhost:3000/` :)
+- the default login is `test@example.com` and password `password`
+
## License
Dual licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php) and [GPL](http://www.gnu.org/licenses/gpl.html) licenses.

0 comments on commit 43032fe

Please sign in to comment.