README.md 5.79 KB
Newer Older
Thomas Park's avatar
Thomas Park committed
1
2
3
# [Bootstrap](http://getbootstrap.com)
[![Bower version](https://badge.fury.io/bo/bootstrap.svg)](http://badge.fury.io/bo/bootstrap)
[![NPM version](https://badge.fury.io/js/bootstrap.svg)](http://badge.fury.io/js/bootstrap)
Thomas Park's avatar
Thomas Park committed
4
[![Build Status](https://secure.travis-ci.org/twbs/bootstrap.svg?branch=master)](https://travis-ci.org/twbs/bootstrap)
Thomas Park's avatar
Thomas Park committed
5
[![devDependency Status](https://david-dm.org/twbs/bootstrap/dev-status.svg)](https://david-dm.org/twbs/bootstrap#info=devDependencies)
Thomas Park's avatar
Thomas Park committed
6
[![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
Thomas Park's avatar
Thomas Park committed
7

Thomas Park's avatar
Thomas Park committed
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/twbs?tab=members) with the massive support and involvement of the community.
Thomas Park's avatar
Thomas Park committed
9

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

Thomas Park's avatar
Thomas Park committed
12
## Table of contents
Thomas Park's avatar
Thomas Park committed
13

Thomas Park's avatar
Thomas Park committed
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)
Thomas Park's avatar
Thomas Park committed
22
23
24

## Quick start

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

Thomas Park's avatar
Thomas Park committed
27
- [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.1.zip).
Thomas Park's avatar
Thomas Park committed
28
29
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
- Install with [Bower](http://bower.io): `bower install bootstrap`.
Thomas Park's avatar
Thomas Park committed
30
- Install with [npm](https://www.npmjs.org): `npm install bootstrap`.
Thomas Park's avatar
Thomas Park committed
31

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

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

We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). Fonts from Glyphicons are included, as is the optional Bootstrap theme.

Thomas Park's avatar
Thomas Park committed
57
58
59
60


## Bugs and feature requests

Thomas Park's avatar
Thomas Park committed
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).
Thomas Park's avatar
Thomas Park committed
62
63
64
65


## Documentation

Thomas Park's avatar
Thomas Park committed
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.
Thomas Park's avatar
Thomas Park committed
67
68
69

### Running documentation locally

Thomas Park's avatar
Thomas Park committed
70
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x).
Thomas Park's avatar
Thomas Park committed
71
72
73
74
  - **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`.
3. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
4. Open <http://localhost:9001> in your browser, and voilà.
Thomas Park's avatar
Thomas Park committed
75

Thomas Park's avatar
Thomas Park committed
76
Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
Thomas Park's avatar
Thomas Park committed
77
78
79

### Documentation for previous releases

Thomas Park's avatar
Thomas Park committed
80
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.
Thomas Park's avatar
Thomas Park committed
81
82
83
84
85
86
87

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



## Contributing

Thomas Park's avatar
Thomas Park committed
88
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.
Thomas Park's avatar
Thomas Park committed
89

Thomas Park's avatar
Thomas Park committed
90
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).
Thomas Park's avatar
Thomas Park committed
91

Thomas Park's avatar
Thomas Park committed
92
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>.
Thomas Park's avatar
Thomas Park committed
93
94
95
96
97
98
99



## Community

Keep track of development and community news.

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



## Versioning

Thomas Park's avatar
Thomas Park committed
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.
Thomas Park's avatar
Thomas Park committed
110
111
112



Thomas Park's avatar
Thomas Park committed
113
## Creators
Thomas Park's avatar
Thomas Park committed
114
115
116

**Mark Otto**

Thomas Park's avatar
Thomas Park committed
117
118
- <https://twitter.com/mdo>
- <https://github.com/mdo>
Thomas Park's avatar
Thomas Park committed
119
120
121

**Jacob Thornton**

Thomas Park's avatar
Thomas Park committed
122
123
- <https://twitter.com/fat>
- <https://github.com/fat>
Thomas Park's avatar
Thomas Park committed
124
125
126
127
128



## Copyright and license

Thomas Park's avatar
Thomas Park committed
129
Code and documentation copyright 2011-2014 Twitter, Inc. Code released under [the MIT license](LICENSE). Docs released under [Creative Commons](docs/LICENSE).