README.md 6.92 KB
Newer Older
1
# [Bootstrap](http://getbootstrap.com)
Mark Otto's avatar
Mark Otto committed
2

vsn4ik's avatar
vsn4ik committed
3
[![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com)
4
5
6
7
![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)
8
[![NuGet](https://img.shields.io/nuget/vpre/bootstrap.svg)](https://www.nuget.org/packages/bootstrap/4.0.0-alpha2)
9
[![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
Jacob Thornton's avatar
Jacob Thornton committed
10

11
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
12

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

15
16
## Table of contents

17
18
19
20
21
22
23
24
- [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
25

Mark Otto's avatar
Mark Otto committed
26
## Quick start
Mark Otto's avatar
Mark Otto committed
27

28
Several quick start options are available:
29

30
- [Download the latest release](https://github.com/twbs/bootstrap/archive/v4.0.0-alpha.2.zip).
31
32
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
- Install with [Bower](http://bower.io): `bower install bootstrap`.
Chris Rebert's avatar
Chris Rebert committed
33
- Install with [npm](https://www.npmjs.com): `npm install bootstrap@4`.
34
35
- Install with [Meteor](https://www.meteor.com): `meteor add twbs:bootstrap`.
- Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap`.
36
- Install with [NuGet](https://www.nuget.org): CSS: `Install-Package bootstrap -Pre` Sass: `Install-Package bootstrap.sass -Pre` (`-Pre` is only required until Bootstrap v4 has a stable release).
Jacob Thornton's avatar
Jacob Thornton committed
37

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

40
41
42
43
44
45
46
47
### 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
48
│   ├── bootstrap.css.map
49
│   ├── bootstrap.min.css
Mark Otto's avatar
Mark Otto committed
50
│   └── bootstrap.min.css.map
51
52
53
└── js/
    ├── bootstrap.js
    └── bootstrap.min.js
54
55
```

Mark Otto's avatar
Mark Otto committed
56
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.
Mark Otto's avatar
Mark Otto committed
57

Mark Otto's avatar
Mark Otto committed
58

Mark Otto's avatar
Mark Otto committed
59
## Bugs and feature requests
Mark Otto's avatar
Mark Otto committed
60

61
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).
62
63


64
## Documentation
65

66
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.
67

68
69
### Running documentation locally

70
1. Run through the [tooling setup](https://github.com/twbs/bootstrap/blob/v4-dev/docs/getting-started/build-tools.md#tooling-setup) to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`.
71
72
2. From the root `/bootstrap` directory, run `bundle exec jekyll serve` in the command line.
3. Open <http://localhost:9001> in your browser, and voilà.
73

Zlatan Vasović's avatar
Zlatan Vasović committed
74
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
75
76
77

### Documentation for previous releases

78
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.
79

80
[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
81
82
83



Mark Otto's avatar
Mark Otto committed
84
85
## Contributing

86
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.
87

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

90
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
91

Jacob Thornton's avatar
Jacob Thornton committed
92

Mark Otto's avatar
Mark Otto committed
93

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

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

98
- Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
99
- Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
vsn4ik's avatar
vsn4ik committed
100
- Join [the official Slack room](https://bootstrap-slack.herokuapp.com).
Siecje's avatar
Siecje committed
101
- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
102
- Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
Kevin Kirsche's avatar
Kevin Kirsche committed
103
- 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
104
105
106
107
108



## Versioning

109
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
110

Chris Rebert's avatar
Chris Rebert committed
111
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.
Mark Otto's avatar
Mark Otto committed
112
113


Chris Rebert's avatar
Chris Rebert committed
114
## Creators
115

Mark Otto's avatar
Mark Otto committed
116
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
117

118
119
- <https://twitter.com/mdo>
- <https://github.com/mdo>
120

Mark Otto's avatar
Mark Otto committed
121
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
122

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

Mark Otto's avatar
Mark Otto committed
126

Mark Otto's avatar
Mark Otto committed
127

Mark Otto's avatar
Mark Otto committed
128
## Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
129

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