2012-12-05 19:05:10 +00:00
# [Twitter Bootstrap v3.0.0](http://twitter.github.com/bootstrap) [![Build Status](https://secure.travis-ci.org/twitter/bootstrap.png)](http://travis-ci.org/twitter/bootstrap)
2011-07-29 21:24:27 +00:00
2012-10-06 21:42:07 +00:00
Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created and maintained by [Mark Otto ](http://twitter.com/mdo ) and [Jacob Thornton ](http://twitter.com/fat ).
2012-02-20 06:52:32 +00:00
2012-08-20 06:05:16 +00:00
To get started, checkout http://getbootstrap.com!
2012-02-20 06:52:32 +00:00
2012-12-02 21:14:49 +00:00
## Quick start
2012-02-20 06:52:32 +00:00
2012-12-03 02:15:40 +00:00
Three quick start options are available:
2011-04-28 06:05:19 +00:00
2012-12-02 21:14:49 +00:00
* [Download the latest release ](https://github.com/twitter/bootstrap/zipball/master ).
* Clone the repo: `git clone git://github.com/twitter/bootstrap.git` .
* Install with Twitter's [Bower ](http://twitter.github.com/bower ): `bower install bootstrap` .
2011-08-17 06:14:09 +00:00
2011-06-29 14:54:55 +00:00
2012-12-02 21:14:49 +00:00
## Versioning
2011-08-30 04:26:53 +00:00
2012-02-01 21:14:49 +00:00
For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.
2011-08-30 04:26:53 +00:00
2012-07-23 19:51:36 +00:00
Releases will be numbered with the following format:
2011-08-30 04:26:53 +00:00
`<major>.<minor>.<patch>`
And constructed with the following guidelines:
2012-03-21 20:00:58 +00:00
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
2012-03-20 05:02:00 +00:00
* Bug fixes and misc changes bumps the patch
2011-08-30 04:26:53 +00:00
For more information on SemVer, please visit http://semver.org/.
2012-02-20 06:52:32 +00:00
2012-12-02 21:14:49 +00:00
## Bug tracker
2011-09-12 21:33:00 +00:00
2012-12-02 21:14:49 +00:00
Have a bug or a feature request? [Please open a new issue ](https://github.com/twitter/bootstrap/issues ). Before opening any issue, please search for existing issues and read the [Issue Guidelines ](https://github.com/necolas/issue-guidelines ), written by [Nicolas Gallagher ](https://github.com/necolas/ ).
2012-03-22 07:33:18 +00:00
2012-12-02 21:14:49 +00:00
## Community
2012-03-22 07:33:18 +00:00
2012-12-02 21:14:49 +00:00
Keep track of development and community news.
2011-08-18 18:37:18 +00:00
2012-12-02 21:14:49 +00:00
* Follow [@twbootstrap on Twitter ](http://twitter.com/twbootstrap ).
* Read and subscribe to the [The Official Twitter Bootstrap Blog ](http://blog.getbootstrap.com ).
* Have a question that's not a feature request or bug report? [Ask on the mailing list. ](http://groups.google.com/group/twitter-bootstrap )
* Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel.
2011-08-18 23:58:22 +00:00
2011-08-18 23:58:49 +00:00
2011-08-18 18:37:18 +00:00
2012-12-02 21:14:49 +00:00
## Developers
2011-08-18 21:45:07 +00:00
2011-11-28 06:13:54 +00:00
We have included a makefile with convenience methods for working with the Bootstrap library.
2011-08-18 21:45:07 +00:00
2012-04-14 23:29:53 +00:00
+ **dependencies**
2012-07-04 06:34:11 +00:00
Our makefile depends on you having recess, connect, uglify.js, and jshint installed. To install, just run the following command in npm:
2012-04-14 23:29:53 +00:00
```
2012-07-04 06:34:11 +00:00
$ npm install recess connect uglify-js jshint -g
2012-04-14 23:29:53 +00:00
```
2012-01-27 06:11:32 +00:00
+ **build** - `make`
2012-10-14 01:37:18 +00:00
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 >
2011-08-18 21:45:07 +00:00
2012-04-20 00:34:07 +00:00
+ **test** - `make test`
2012-08-22 17:44:41 +00:00
Runs jshint and qunit tests headlessly in [phantomjs ](http://code.google.com/p/phantomjs/ ) (used for ci). Depends on having phantomjs installed.
2012-04-20 00:34:07 +00:00
2011-08-18 21:45:07 +00:00
+ **watch** - `make watch`
2012-02-13 00:04:02 +00:00
This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem.
2011-08-18 18:37:18 +00:00
2011-08-19 18:25:19 +00:00
2012-08-20 06:05:16 +00:00
2012-12-02 21:14:49 +00:00
## Contributing
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 ).
2012-05-28 03:07:58 +00:00
2012-12-02 21:14:49 +00:00
Thanks!
2012-08-20 06:05:16 +00:00
2012-05-28 03:07:58 +00:00
2012-02-20 06:52:32 +00:00
2012-12-02 21:14:49 +00:00
## Authors
2011-04-28 06:05:19 +00:00
2011-04-28 06:12:49 +00:00
**Mark Otto**
2011-07-29 21:26:33 +00:00
+ http://twitter.com/mdo
2012-12-02 21:14:49 +00:00
+ http://github.com/mdo
2011-04-28 06:05:19 +00:00
2011-07-29 19:30:59 +00:00
**Jacob Thornton**
2011-07-29 21:26:33 +00:00
+ http://twitter.com/fat
+ http://github.com/fat
2011-07-29 19:30:59 +00:00
2011-06-29 14:54:55 +00:00
2012-02-20 06:52:32 +00:00
2012-12-02 21:14:49 +00:00
## Copyright and license
2011-05-10 22:30:49 +00:00
2012-01-15 07:28:48 +00:00
Copyright 2012 Twitter, Inc.
2011-05-10 22:30:49 +00:00
2011-06-29 14:54:55 +00:00
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this work except in compliance with the License.
You may obtain a copy of the License in the LICENSE file, or at:
2011-04-28 06:12:49 +00:00
2011-06-29 14:54:55 +00:00
http://www.apache.org/licenses/LICENSE-2.0
2011-04-28 06:05:19 +00:00
2011-06-29 14:54:55 +00:00
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
2011-09-12 04:56:54 +00:00
limitations under the License.