README.md 6.2 KB
Newer Older
1
# [Bootstrap](http://getbootstrap.com)
2
3
4
5
![Bower version](https://img.shields.io/bower/v/bootstrap.svg?style=flat)
[![npm version](https://img.shields.io/npm/v/bootstrap.svg?style=flat)](https://www.npmjs.com/package/bootstrap)
[![Build Status](https://img.shields.io/travis/twbs/bootstrap/master.svg?style=flat)](https://travis-ci.org/twbs/bootstrap)
[![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg?style=flat)](https://david-dm.org/twbs/bootstrap#info=devDependencies)
6
[![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
Jacob Thornton's avatar
Jacob Thornton committed
7

8
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
9

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

12
13
## Table of contents

14
15
16
17
18
19
20
21
- [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
22

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

vsn4ik's avatar
vsn4ik committed
25
Four quick start options are available:
26

Mark Otto's avatar
Mark Otto committed
27
- [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.2.zip).
28
29
- 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
30
- Install with [npm](https://www.npmjs.org): `npm install bootstrap`.
Jacob Thornton's avatar
Jacob Thornton committed
31

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

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

vsn4ik's avatar
vsn4ik committed
58
We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). CSS [source maps](https://developers.google.com/chrome-developer-tools/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.
59

Mark Otto's avatar
Mark Otto committed
60

Mark Otto's avatar
Mark Otto committed
61

Mark Otto's avatar
Mark Otto committed
62
## Bugs and feature requests
Mark Otto's avatar
Mark Otto committed
63

64
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).
65
66


67
## Documentation
68

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

71
72
### Running documentation locally

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

Zlatan Vasović's avatar
Zlatan Vasović committed
79
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
80
81
82

### Documentation for previous releases

83
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.
84

85
[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
86
87
88



Mark Otto's avatar
Mark Otto committed
89
90
## Contributing

91
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.
92

93
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](https://github.com/mdo/code-guide), maintained by [Mark Otto](https://github.com/mdo).
Jacob Thornton's avatar
Jacob Thornton committed
94

95
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
96

Jacob Thornton's avatar
Jacob Thornton committed
97

Mark Otto's avatar
Mark Otto committed
98

Mark Otto's avatar
Mark Otto committed
99
100
101
102
## Community

Keep track of development and community news.

103
- Follow [@twbootstrap on Twitter](https://twitter.com/twbootstrap).
104
- Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
Siecje's avatar
Siecje committed
105
- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
106
- Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](http://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
Mark Otto's avatar
Mark Otto committed
107
108
109
110
111



## Versioning

112
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
113
114
115



Chris Rebert's avatar
Chris Rebert committed
116
## Creators
117

Mark Otto's avatar
Mark Otto committed
118
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
119

120
121
- <https://twitter.com/mdo>
- <https://github.com/mdo>
122

Mark Otto's avatar
Mark Otto committed
123
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
124

125
126
- <https://twitter.com/fat>
- <https://github.com/fat>
Mark Otto's avatar
Mark Otto committed
127

Mark Otto's avatar
Mark Otto committed
128

Mark Otto's avatar
Mark Otto committed
129

Mark Otto's avatar
Mark Otto committed
130
## Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
131

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