Permalink
Browse files

add info about Makefile to README.md

  • Loading branch information...
nragaz committed May 12, 2012
1 parent 54deef6 commit b5b876f687cbd184a743886b6844bafc1ffe2cf5
Showing with 25 additions and 3 deletions.
  1. +25 −3 README.md
View
@@ -86,10 +86,10 @@ Server: irc.freenode.net
Channel: ##twitter-bootstrap (the double ## is not a typo)
-Developers
-----------
+SASS Developers
+---------------
-We have included a Rakefile with convenience methods for working with the Bootstrap library.
+We have included a Rakefile with convenience methods for working with the SASS Bootstrap library.
+ **build** - `rake build`
This will run the less compiler on the bootstrap lib and regenerate the docs dir.
@@ -99,6 +99,28 @@ The lessc compiler is required for this command to run.
This is a convenience method for watching your Sass files and automatically building them whenever you save.
+Developers
+----------
+
+We have included a makefile with convenience methods for working with the Bootstrap library.
+
++ **dependencies**
+Our makefile depends on you having recess, uglify.js, and jshint installed. To install, just run the following command in npm:
+
+```
+$ npm install recess uglify-js jshint -g
+```
+
++ **build** - `make`
+Runs the recess compiler to rebuild the `/less` files and compiles the docs pages. Requires recess and uglify-js. <a href="http://twitter.github.com/bootstrap/less.html#compiling">Read more in our docs &raquo;</a>
+
++ **test** - `make test`
+Runs jshint and qunit tests headlessly in phantom js (used for ci). Depends on having phatomjs installed.
+
++ **watch** - `make watch`
+This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem.
+
+
Authors
-------

0 comments on commit b5b876f

Please sign in to comment.