0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-04 16:24:22 +01:00
Bootstrap/README.md

143 lines
7.2 KiB
Markdown
Raw Normal View History

# [Bootstrap](http://getbootstrap.com)
2015-05-16 18:52:17 +02:00
2015-04-25 20:05:49 +02:00
[![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com)
![Bower version](https://img.shields.io/bower/v/bootstrap.svg)
[![npm version](https://img.shields.io/npm/v/bootstrap.svg)](https://www.npmjs.com/package/bootstrap)
[![Build Status](https://img.shields.io/travis/twbs/bootstrap/master.svg)](https://travis-ci.org/twbs/bootstrap)
[![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.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 23:24:27 +02:00
Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by [Mark Otto](https://twitter.com/mdo) and [Jacob Thornton](https://twitter.com/fat), and maintained by the [core team](https://github.com/orgs/twbs/people) with the massive support and involvement of the community.
2012-02-20 07:52:32 +01:00
2013-10-20 18:50:14 +02:00
To get started, check out <http://getbootstrap.com>!
2012-02-20 07:52:32 +01:00
## Table of contents
2015-05-16 18:52:17 +02:00
* [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 07:52:32 +01:00
## Quick start
2012-02-20 07:52:32 +01:00
Several quick start options are available:
2015-05-16 18:52:17 +02:00
* [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.5.zip).
* Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
* Install with [Bower](http://bower.io): `bower install bootstrap`.
* Install with [npm](https://www.npmjs.com): `npm install bootstrap`.
* Install with [Meteor](https://www.meteor.com): `meteor add twbs:bootstrap`.
* Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap`.
2011-08-17 08:14:09 +02: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
2014-12-05 18:00:19 +01:00
│ ├── bootstrap.css.map
│ ├── bootstrap.min.css
2015-06-19 21:46:34 +02:00
│ ├── bootstrap.min.css.map
│ ├── bootstrap-theme.css
2014-12-05 18:00:19 +01:00
│ ├── bootstrap-theme.css.map
2015-06-19 21:46:34 +02:00
│ ├── bootstrap-theme.min.css
│ └── bootstrap-theme.min.css.map
├── js/
│ ├── bootstrap.js
│ └── bootstrap.min.js
└── fonts/
├── glyphicons-halflings-regular.eot
├── glyphicons-halflings-regular.svg
├── glyphicons-halflings-regular.ttf
2014-12-15 10:00:19 +01:00
├── glyphicons-halflings-regular.woff
└── glyphicons-halflings-regular.woff2
```
2015-05-25 19:11:42 +02:00
We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). CSS [source maps](https://developer.chrome.com/devtools/docs/css-preprocessors) (`bootstrap.*.map`) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included, as is the optional Bootstrap theme.
2011-06-29 16:54:55 +02:00
2013-02-14 05:01:36 +01:00
## Bugs and feature requests
2011-09-12 23:33:00 +02:00
2014-01-09 20:33:13 +01: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 08:33:18 +01:00
## Documentation
2013-10-18 21:34:18 +02: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
2015-05-16 18:52:17 +02:00
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x).
**Note for Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) 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`.
2014-07-08 13:33:21 +02:00
3. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
2015-05-16 18:52:17 +02:00
4. 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 21:34:18 +02: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.
Moreover, if your pull request contains JavaScript patches or features, you must include [relevant unit tests](https://github.com/twbs/bootstrap/tree/master/js/tests). All HTML and CSS should conform to the [Code Guide](https://github.com/mdo/code-guide), maintained by [Mark Otto](https://github.com/mdo).
2012-05-28 05:07:58 +02:00
2014-01-09 20:33:13 +01: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 08:02:57 +02:00
2012-05-28 05:07:58 +02:00
2012-02-20 07:52:32 +01:00
2013-02-15 08:48:29 +01:00
## Community
Get updates on Bootstrap's development and chat with the project maintainers and community members.
2013-02-15 08:48:29 +01:00
2015-05-16 18:52:17 +02:00
* Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
* Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
* Join [the official Slack room](https://bootstrap-slack.herokuapp.com).
* Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
* Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](https://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
* Developers should use the keyword `bootstrap` on packages which modify or add to the functionality of Bootstrap when distributing through [npm](https://www.npmjs.com/browse/keyword/bootstrap) or similar delivery mechanisms for maximum discoverability.
2013-02-15 08:48:29 +01: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 08:48:29 +01:00
See [the Releases section of our GitHub project](https://github.com/twbs/bootstrap/releases) for changelogs for each release version of Bootstrap. Release announcement posts on [the official Bootstrap blog](http://blog.getbootstrap.com) contain summaries of the most noteworthy changes made in each release.
2013-02-15 08:48:29 +01:00
2014-04-23 23:08:25 +02:00
## Creators
2011-04-28 08:12:49 +02:00
**Mark Otto**
2011-07-29 23:26:33 +02:00
2015-05-16 18:52:17 +02:00
* <https://twitter.com/mdo>
* <https://github.com/mdo>
2011-07-29 21:30:59 +02:00
**Jacob Thornton**
2011-07-29 23:26:33 +02:00
2015-05-16 18:52:17 +02:00
* <https://twitter.com/fat>
* <https://github.com/fat>
2011-07-29 21:30:59 +02:00
2011-06-29 16:54:55 +02:00
2012-02-20 07:52:32 +01:00
## Copyright and license
2011-05-11 00:30:49 +02:00
2015-01-01 01:23:48 +01:00
Code and documentation copyright 2011-2015 Twitter, Inc. Code released under [the MIT license](https://github.com/twbs/bootstrap/blob/master/LICENSE). Docs released under [Creative Commons](https://github.com/twbs/bootstrap/blob/master/docs/LICENSE).