aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2013-02-21 13:10:21 -0800
committerMark Otto <[email protected]>2013-02-21 13:10:21 -0800
commit16111a5e454a8af4407f4217b5defb6d7a9bdbd3 (patch)
tree95161525203f55e6d9f92add41e8673dc7db7173
parent8c7f9c66a7d12f47f50618ef420868fe836d0c33 (diff)
parente6a6fd2585d6d6bd80b0bbb500521514c48df1b3 (diff)
downloadbootstrap-16111a5e454a8af4407f4217b5defb6d7a9bdbd3.tar.xz
bootstrap-16111a5e454a8af4407f4217b5defb6d7a9bdbd3.zip
Merge pull request #6967 from twitter/readme_npm_fix
Update readme npm instructions
-rw-r--r--README.md21
1 files changed, 11 insertions, 10 deletions
diff --git a/README.md b/README.md
index 4f74a15f2..efe9e158a 100644
--- a/README.md
+++ b/README.md
@@ -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 &raquo;</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