diff options
| -rw-r--r-- | README.md | 21 |
1 files changed, 11 insertions, 10 deletions
@@ -55,26 +55,27 @@ Keep track of development and community news. -## Developers +## Compiling CSS and JavaScript -We have included a makefile with convenience methods for working with the Bootstrap library. - -+ **dependencies** -Our makefile depends on you having recess, connect, uglify.js, and jshint installed. To install, just run the following command in npm: +Bootstrap includes a [makefile](Makefile) with convenient methods for working with the framework. Before getting started, be sure to install [the necessary local dependencies](package.json): ``` -$ npm install recess connect uglify-js jshint -g +$ npm install ``` -+ **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/extend.html#compiling">Read more in our docs »</a> +When completed, you'll be able to run the various make commands provided: + +#### build - `make` +Runs the recess compiler to rebuild the `/less` files and compiles the docs. Requires recess and uglify-js. -+ **test** - `make test` +#### test - `make test` Runs jshint and qunit tests headlessly in [phantomjs](http://code.google.com/p/phantomjs/) (used for ci). Depends on having phantomjs installed. -+ **watch** - `make watch` +#### watch - `make watch` This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem. +Should you encounter problems with installing dependencies or running the makefile commands, be sure to first uninstall any previous versions (global and local) you may have installed, and then rerun `npm install`. + ## Contributing |