README.md 6.91 KB
Newer Older
1
# [Bootstrap](http://getbootstrap.com)
vsn4ik's avatar
vsn4ik committed
2
[![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com)
3
4
5
6
![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)
7
[![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
Jacob Thornton's avatar
Jacob Thornton committed
8

9
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.
Mark Otto's avatar
Mark Otto committed
10

11
To get started, check out <http://getbootstrap.com>!
Mark Otto's avatar
Mark Otto committed
12

13
14
## Table of contents

15
16
17
18
19
20
21
22
- [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)
Mark Otto's avatar
Mark Otto committed
23

Mark Otto's avatar
Mark Otto committed
24
## Quick start
Mark Otto's avatar
Mark Otto committed
25

26
Several quick start options are available:
27

Mark Otto's avatar
Mark Otto committed
28
- [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.5.zip).
29
30
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
- Install with [Bower](http://bower.io): `bower install bootstrap`.
vsn4ik's avatar
vsn4ik committed
31
- Install with [npm](https://www.npmjs.com): `npm install bootstrap`.
32
33
- Install with [Meteor](https://www.meteor.com): `meteor add twbs:bootstrap`.
- Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap`.
Jacob Thornton's avatar
Jacob Thornton committed
34

Zlatan Vasović's avatar
Zlatan Vasović committed
35
Read the [Getting started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
36

37
38
39
40
41
42
43
44
### 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
vsn4ik's avatar
vsn4ik committed
45
│   ├── bootstrap.css.map
46
│   ├── bootstrap.min.css
vsn4ik's avatar
vsn4ik committed
47
│   ├── bootstrap.min.css.map
48
│   ├── bootstrap-theme.css
vsn4ik's avatar
vsn4ik committed
49
│   ├── bootstrap-theme.css.map
vsn4ik's avatar
vsn4ik committed
50
51
│   ├── bootstrap-theme.min.css
│   └── bootstrap-theme.min.css.map
52
53
54
55
56
57
58
├── js/
│   ├── bootstrap.js
│   └── bootstrap.min.js
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
Bastien's avatar
Bastien committed
59
60
    ├── glyphicons-halflings-regular.woff
    └── glyphicons-halflings-regular.woff2
61
62
```

Morton Fox's avatar
Morton Fox committed
63
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.
64

Mark Otto's avatar
Mark Otto committed
65

Mark Otto's avatar
Mark Otto committed
66

Mark Otto's avatar
Mark Otto committed
67
## Bugs and feature requests
Mark Otto's avatar
Mark Otto committed
68

69
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).
70
71


72
## Documentation
73

74
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.
75

76
77
### Running documentation locally

XhmikosR's avatar
XhmikosR committed
78
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x).
79
  - **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems.
80
2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`.
Julian Thilo's avatar
Julian Thilo committed
81
82
3. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
4. Open <http://localhost:9001> in your browser, and voilà.
83

Zlatan Vasović's avatar
Zlatan Vasović committed
84
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
85
86
87

### Documentation for previous releases

88
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.
89

90
[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
91
92
93



Mark Otto's avatar
Mark Otto committed
94
95
## Contributing

96
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.
97

98
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).
Jacob Thornton's avatar
Jacob Thornton committed
99

100
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>.
Mark Otto's avatar
Mark Otto committed
101

Jacob Thornton's avatar
Jacob Thornton committed
102

Mark Otto's avatar
Mark Otto committed
103

Mark Otto's avatar
Mark Otto committed
104
105
## Community

106
Get updates on Bootstrap's development and chat with the project maintainers and community members.
Mark Otto's avatar
Mark Otto committed
107

108
- Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
109
- Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
vsn4ik's avatar
vsn4ik committed
110
- Join [the official Slack room](https://bootstrap-slack.herokuapp.com).
Siecje's avatar
Siecje committed
111
- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
XhmikosR's avatar
XhmikosR committed
112
- Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](https://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
Kevin Kirsche's avatar
Kevin Kirsche committed
113
- 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.
Mark Otto's avatar
Mark Otto committed
114
115
116
117
118



## Versioning

119
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.
Mark Otto's avatar
Mark Otto committed
120
121
122



Chris Rebert's avatar
Chris Rebert committed
123
## Creators
124

Mark Otto's avatar
Mark Otto committed
125
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
126

127
128
- <https://twitter.com/mdo>
- <https://github.com/mdo>
129

Mark Otto's avatar
Mark Otto committed
130
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
131

132
133
- <https://twitter.com/fat>
- <https://github.com/fat>
Mark Otto's avatar
Mark Otto committed
134

Mark Otto's avatar
Mark Otto committed
135

Mark Otto's avatar
Mark Otto committed
136

Mark Otto's avatar
Mark Otto committed
137
## Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
138

Zlatan Vasović's avatar
Zlatan Vasović committed
139
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).