Permalink
Browse files

Modified changeme

  • Loading branch information...
makoto committed May 9, 2012
1 parent af437c8 commit 97553edf76fbee85609c5885da60d9d623e5c9a3
Showing with 31 additions and 23 deletions.
  1. +31 −23 README.md
View
@@ -64,29 +64,37 @@ For some more complex examples, see the following page:
We welcome pull requests! Some things to keep in mind:
-* To run the test server you need the following gems: <b>rack & sinatra</b>
- <br />This is the current gem list:
- <pre>
- albino (1.3.3)
- classifier (1.3.3)
- directory_watcher (1.4.1)
- fast-stemmer (1.0.0)
- jekyll (0.11.2)
- kramdown (0.13.5)
- liquid (2.3.0)
- maruku (0.6.0)
- posix-spawn (0.3.6)
- rack (1.4.0)
- rack-contrib (1.1.0)
- rack-protection (1.2.0)
- rake (0.8.7)
- sinatra (1.3.2)
- syntax (1.0.0)
- tilt (1.3.3)
- </pre>
-
- When those are installed, you can run the test server like so:
- ```cd test && rackup ```
+### Set up
+
+Assuming that Ruby is already installed on your machine, you need to install bundler gem to install other required gems so that you can run the test server.
+
+ $ cd test
+ $ gem install bundler
+
+Once bundler is installed, run ``bundle install`` which install required gems (mostly sinatra)
+
+ $ bundle install
+ Fetching source index for http://rubygems.org/
+ Using rack (1.4.1)
+ Installing rack-contrib (1.1.0)
+ Using rack-protection (1.2.0)
+ Using tilt (1.3.3)
+ Using sinatra (1.3.2)
+ Using bundler (1.0.21)
+
+Once all the required gems are installed, run the following command
+
+ $ rackup
+ >>> Serving: ~/dataset/test/../
+ >> Thin web server (v1.3.1 codename Triple Espresso)
+ >> Maximum connections set to 1024
+ >> Listening on 0.0.0.0:9292, CTRL+C to stop
+
+Open the test page on the browser
+
+ open http://localhost:9292/test/index.html
+
+### Guideline
* Any new functionality must have tests and ensure all current tests still pass. All tests are located in the ```test/unit``` directory.
* We use cowboy's grunt library to build all our final dependencies. You will need to install grunt per the instructions here: [https://github.com/cowboy/grunt](https://github.com/cowboy/grunt).

0 comments on commit 97553ed

Please sign in to comment.