1 | # [Bootstrap](http://getbootstrap.com) |
---|
2 | |
---|
3 | [![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com) |
---|
4 | ![Bower version](https://img.shields.io/bower/v/bootstrap.svg) |
---|
5 | [![npm version](https://img.shields.io/npm/v/bootstrap.svg)](https://www.npmjs.com/package/bootstrap) |
---|
6 | [![Build Status](https://img.shields.io/travis/twbs/bootstrap/master.svg)](https://travis-ci.org/twbs/bootstrap) |
---|
7 | [![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/v/bootstrap.svg)](https://www.nuget.org/packages/Bootstrap) |
---|
9 | [![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap) |
---|
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. |
---|
12 | |
---|
13 | To get started, check out <http://getbootstrap.com>! |
---|
14 | |
---|
15 | |
---|
16 | ## Table of contents |
---|
17 | |
---|
18 | * [Quick start](#quick-start) |
---|
19 | * [Bugs and feature requests](#bugs-and-feature-requests) |
---|
20 | * [Documentation](#documentation) |
---|
21 | * [Contributing](#contributing) |
---|
22 | * [Community](#community) |
---|
23 | * [Versioning](#versioning) |
---|
24 | * [Creators](#creators) |
---|
25 | * [Copyright and license](#copyright-and-license) |
---|
26 | |
---|
27 | |
---|
28 | ## Quick start |
---|
29 | |
---|
30 | Several quick start options are available: |
---|
31 | |
---|
32 | * [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.6.zip). |
---|
33 | * Clone the repo: `git clone https://github.com/twbs/bootstrap.git`. |
---|
34 | * Install with [Bower](http://bower.io): `bower install bootstrap`. |
---|
35 | * Install with [npm](https://www.npmjs.com): `npm install bootstrap`. |
---|
36 | * Install with [Meteor](https://www.meteor.com): `meteor add twbs:bootstrap`. |
---|
37 | * Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap`. |
---|
38 | |
---|
39 | Read the [Getting started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more. |
---|
40 | |
---|
41 | ### What's included |
---|
42 | |
---|
43 | 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: |
---|
44 | |
---|
45 | ``` |
---|
46 | bootstrap/ |
---|
47 | ├── css/ |
---|
48 | │ ├── bootstrap.css |
---|
49 | │ ├── bootstrap.css.map |
---|
50 | │ ├── bootstrap.min.css |
---|
51 | │ ├── bootstrap.min.css.map |
---|
52 | │ ├── bootstrap-theme.css |
---|
53 | │ ├── bootstrap-theme.css.map |
---|
54 | │ ├── bootstrap-theme.min.css |
---|
55 | │ └── bootstrap-theme.min.css.map |
---|
56 | ├── js/ |
---|
57 | │ ├── bootstrap.js |
---|
58 | │ └── bootstrap.min.js |
---|
59 | └── fonts/ |
---|
60 | ├── glyphicons-halflings-regular.eot |
---|
61 | ├── glyphicons-halflings-regular.svg |
---|
62 | ├── glyphicons-halflings-regular.ttf |
---|
63 | ├── glyphicons-halflings-regular.woff |
---|
64 | └── glyphicons-halflings-regular.woff2 |
---|
65 | ``` |
---|
66 | |
---|
67 | 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. |
---|
68 | |
---|
69 | |
---|
70 | ## Bugs and feature requests |
---|
71 | |
---|
72 | 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). |
---|
73 | |
---|
74 | |
---|
75 | ## Documentation |
---|
76 | |
---|
77 | 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. |
---|
78 | |
---|
79 | ### Running documentation locally |
---|
80 | |
---|
81 | 1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v3.0.x). |
---|
82 | **Note for Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems. |
---|
83 | 2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`. |
---|
84 | 3. From the root `/bootstrap` directory, run `jekyll serve` in the command line. |
---|
85 | 4. Open `http://localhost:9001` in your browser, and voilà. |
---|
86 | |
---|
87 | Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/). |
---|
88 | |
---|
89 | ### Documentation for previous releases |
---|
90 | |
---|
91 | 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. |
---|
92 | |
---|
93 | [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download. |
---|
94 | |
---|
95 | |
---|
96 | ## Contributing |
---|
97 | |
---|
98 | 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. |
---|
99 | |
---|
100 | 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). |
---|
101 | |
---|
102 | 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>. |
---|
103 | |
---|
104 | |
---|
105 | ## Community |
---|
106 | |
---|
107 | Get updates on Bootstrap's development and chat with the project maintainers and community members. |
---|
108 | |
---|
109 | * Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap). |
---|
110 | * Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com). |
---|
111 | * Join [the official Slack room](https://bootstrap-slack.herokuapp.com). |
---|
112 | * Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel. |
---|
113 | * Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](https://stackoverflow.com/questions/tagged/twitter-bootstrap-3)). |
---|
114 | * 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. |
---|
115 | |
---|
116 | |
---|
117 | ## Versioning |
---|
118 | |
---|
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. |
---|
120 | |
---|
121 | 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. |
---|
122 | |
---|
123 | |
---|
124 | ## Creators |
---|
125 | |
---|
126 | **Mark Otto** |
---|
127 | |
---|
128 | * <https://twitter.com/mdo> |
---|
129 | * <https://github.com/mdo> |
---|
130 | |
---|
131 | **Jacob Thornton** |
---|
132 | |
---|
133 | * <https://twitter.com/fat> |
---|
134 | * <https://github.com/fat> |
---|
135 | |
---|
136 | |
---|
137 | ## Copyright and license |
---|
138 | |
---|
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). |
---|