Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
siuying committed Mar 23, 2012
1 parent fe089a6 commit 07e8407
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Expand Up @@ -2,12 +2,21 @@

A web project boilerplate use guard and sprockets to watch and compile your static assets

## Usage
## What it does

- Compile assets (stylesheets (css/scss), javascripts(js/coffee) and images) into /public/assets
- Run jasmine using headless webkit

## Installation

Before using the boilderplate, install the dependencies:

bundle install

You will also need to install [jasmine-headless-webkit](http://johnbintz.github.com/jasmine-headless-webkit/) and its dependencies first.

## Usage

Start development by running the gaurd command:

bundle exec guard start
Expand Down

0 comments on commit 07e8407

Please sign in to comment.