mirror of
https://github.com/twbs/bootstrap.git
synced 2024-11-30 12:24:19 +01:00
117 lines
4.4 KiB
Markdown
117 lines
4.4 KiB
Markdown
<a href="http://getbootstrap.com">
|
|
<img src="http://twitter.github.com/bootstrap/assets/img/bootstrap-docs-readme.png" width="100px">
|
|
</a>
|
|
|
|
# [Bootstrap v2.3.0](http://twitter.github.com/bootstrap) [](http://travis-ci.org/twitter/bootstrap)
|
|
|
|
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).
|
|
|
|
To get started, checkout [http://getbootstrap.com](http://getbootstrap.com)!
|
|
|
|
|
|
|
|
## Quick start
|
|
|
|
Three quick start options are available:
|
|
|
|
* [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`.
|
|
|
|
|
|
|
|
## Versioning
|
|
|
|
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.
|
|
|
|
Releases will be numbered with the following format:
|
|
|
|
`<major>.<minor>.<patch>`
|
|
|
|
And constructed with the following guidelines:
|
|
|
|
* 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)
|
|
* Bug fixes and misc changes bumps the patch
|
|
|
|
For more information on SemVer, please visit [http://semver.org/](http://semver.org/).
|
|
|
|
|
|
|
|
## Bug tracker
|
|
|
|
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/).
|
|
|
|
|
|
|
|
## Community
|
|
|
|
Keep track of development and community news.
|
|
|
|
* 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.
|
|
|
|
|
|
|
|
## Developers
|
|
|
|
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:
|
|
|
|
```
|
|
$ npm install recess connect 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/extend.html#compiling">Read more in our docs »</a>
|
|
|
|
+ **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`
|
|
This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem.
|
|
|
|
|
|
|
|
## 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).
|
|
|
|
Thanks!
|
|
|
|
|
|
|
|
## Authors
|
|
|
|
**Mark Otto**
|
|
|
|
+ [http://twitter.com/mdo](http://twitter.com/mdo)
|
|
+ [http://github.com/mdo](http://github.com/mdo)
|
|
|
|
**Jacob Thornton**
|
|
|
|
+ [http://twitter.com/fat](http://twitter.com/fat)
|
|
+ [http://github.com/fat](http://github.com/fat)
|
|
|
|
|
|
|
|
## Copyright and license
|
|
|
|
Copyright 2012 Twitter, Inc.
|
|
|
|
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:
|
|
|
|
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
|
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
|
|
limitations under the License.
|