kotovalexarian-likes-github
/
twbs--bootstrap
mirror of https://github.com/twbs/bootstrap.git
1
0
Fork 0
Code Releases Activity

update readme to reflect jekyll docs and local npm install method

This commit is contained in:
Mark Otto 2013-02-13 12:51:25 -08:00
parent d3c458c7d8
commit 2b05b335b0
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -55,24 +55,31 @@ Keep track of development and community news.
## Developers
## Documentation
We have included a makefile with convenience methods for working with the Bootstrap library.
Bootstrap's docs are built using Jekyll and hosted on GitHub Pages at http://getbootstrap.com. To view our docs locally, you'll need to [install Jekyll](https://github.com/mojombo/jekyll/wiki/install) to run a local server.
+ **dependencies**
Our makefile depends on you having recess, connect, uglify.js, and jshint installed. To install, just run the following command in npm:
Documentation for [previous versions](https://github.com/twitter/bootstrap/tags) is also available via tags.
## Compiling CSS and JavaScript
Bootstrap includes a makefile with convenient methods for working with the framework. Before getting started, be sure to install the necessary local dependencies:
```
$ 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.
Once installed, you'll be able to run the various make commands provided:
+ **test** - `make test`
#### build - `make`
Runs the recess compiler to rebuild the `/less` files and compiles the docs. Requires recess and uglify-js.
#### 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.
@ -81,8 +88,6 @@ This is a convenience method for watching just Less files and automatically buil
Please submit all pull requests against *-wip branches. If your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the [Code Guide](http://github.com/mdo/code-guide), maintained by [Mark Otto](http://github.com/mdo).
Thanks!
## Authors