twbs--bootstrap/README.md

129 lines
5.7 KiB
Markdown
Raw Normal View History

# [Bootstrap](http://getbootstrap.com)
2014-06-15 12:26:32 +00:00
[![Bower version](https://badge.fury.io/bo/bootstrap.svg)](http://badge.fury.io/bo/bootstrap)
[![NPM version](https://badge.fury.io/js/bootstrap.svg)](http://badge.fury.io/js/bootstrap)
[![Build Status](https://secure.travis-ci.org/twbs/bootstrap.svg?branch=master)](http://travis-ci.org/twbs/bootstrap)
[![devDependency Status](https://david-dm.org/twbs/bootstrap/dev-status.svg)](https://david-dm.org/twbs/bootstrap#info=devDependencies)
[![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
2011-07-29 21:24:27 +00:00
Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by [Mark Otto](http://twitter.com/mdo) and [Jacob Thornton](http://twitter.com/fat), and maintained by the [core team](https://github.com/twbs?tab=members) with the massive support and involvement of the community.
2012-02-20 06:52:32 +00:00
2013-10-20 16:50:14 +00:00
To get started, check out <http://getbootstrap.com>!
2012-02-20 06:52:32 +00:00
## Table of contents
- [Quick start](#quick-start)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Community](#community)
- [Versioning](#versioning)
- [Creators](#creators)
- [Copyright and license](#copyright-and-license)
2012-02-20 06:52:32 +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:
2014-06-26 16:13:24 +00:00
- [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.2.0.zip).
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
- Install with [Bower](http://bower.io): `bower install bootstrap`.
2011-08-17 06:14:09 +00:00
Read the [Getting started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
### What's included
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
```
bootstrap/
├── css/
│ ├── bootstrap.css
│ ├── bootstrap.min.css
│ ├── bootstrap-theme.css
│ └── bootstrap-theme.min.css
├── js/
│ ├── bootstrap.js
│ └── bootstrap.min.js
└── fonts/
├── glyphicons-halflings-regular.eot
├── glyphicons-halflings-regular.svg
├── glyphicons-halflings-regular.ttf
└── glyphicons-halflings-regular.woff
```
We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). Fonts from Glyphicons are included, as is the optional Bootstrap theme.
2011-06-29 14:54:55 +00:00
2013-02-14 04:01:36 +00:00
## Bugs and feature requests
2011-09-12 21:33:00 +00:00
2014-01-09 19:33:13 +00:00
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/twbs/bootstrap/issues/new).
2012-03-22 07:33:18 +00:00
## Documentation
2013-10-18 19:34:18 +00:00
Bootstrap's documentation, included in this repo in the root directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at <http://getbootstrap.com>. The docs may also be run locally.
### Running documentation locally
2014-06-29 05:39:40 +00:00
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.1.x).
- **Windows users:** Read [this unofficial guide](https://github.com/juthilo/run-jekyll-on-windows/) to get Jekyll up and running without problems.
2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`.
2013-07-26 20:58:18 +00:00
2. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
2013-10-18 19:34:18 +00:00
3. Open <http://localhost:9001> in your browser, and voilà.
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
### Documentation for previous releases
2013-10-18 19:34:18 +00:00
Documentation for v2.3.2 has been made available for the time being at <http://getbootstrap.com/2.3.2/> while folks transition to Bootstrap 3.
[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
## Contributing
Please read through our [contributing guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
2014-01-21 08:55:56 +00:00
Moreover, 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
2014-01-09 19:33:13 +00:00
Editor preferences are available in the [editor config](https://github.com/twbs/bootstrap/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
2013-04-23 06:02:57 +00:00
2012-05-28 03:07:58 +00:00
2012-02-20 06:52:32 +00:00
2013-02-15 07:48:29 +00:00
## Community
Keep track of development and community news.
- Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap).
- Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel.
- Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](http://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
2013-02-15 07:48:29 +00:00
## Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under [the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible.
2013-02-15 07:48:29 +00:00
2014-04-23 21:08:25 +00:00
## Creators
2011-04-28 06:12:49 +00:00
**Mark Otto**
2011-07-29 21:26:33 +00:00
- <http://twitter.com/mdo>
- <http://github.com/mdo>
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
## Copyright and license
2011-05-10 22:30:49 +00:00
2014-01-18 22:50:45 +00:00
Code and documentation copyright 2011-2014 Twitter, Inc. Code released under [the MIT license](LICENSE). Docs released under [Creative Commons](docs/LICENSE).