README.md 4.59 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
<a href="http://getbootstrap.com">
Mark Otto's avatar
Mark Otto committed
2
  <img src="http://twitter.github.com/bootstrap/assets/img/bootstrap-docs-readme.png" width="100px">
Mark Otto's avatar
Mark Otto committed
3
4
</a>

5
# [Bootstrap v3.0.0](http://twitter.github.com/bootstrap) [![Build Status](https://secure.travis-ci.org/twitter/bootstrap.png)](http://travis-ci.org/twitter/bootstrap)
Jacob Thornton's avatar
Jacob Thornton committed
6

Mark Otto's avatar
Mark Otto committed
7
Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created and maintained by [Mark Otto](http://twitter.com/mdo) and [Jacob Thornton](http://twitter.com/fat).
Mark Otto's avatar
Mark Otto committed
8

Mark Otto's avatar
Mark Otto committed
9
To get started, checkout [http://getbootstrap.com](http://getbootstrap.com)!
Mark Otto's avatar
Mark Otto committed
10
11
12



Mark Otto's avatar
Mark Otto committed
13
## Quick start
Mark Otto's avatar
Mark Otto committed
14

Mark Otto's avatar
Mark Otto committed
15
Three quick start options are available:
16

Mark Otto's avatar
Mark Otto committed
17
18
19
* [Download the latest release](https://github.com/twitter/bootstrap/zipball/master).
* Clone the repo: `git clone git://github.com/twitter/bootstrap.git`.
* Install with Twitter's [Bower](http://twitter.github.com/bower): `bower install bootstrap`.
Jacob Thornton's avatar
Jacob Thornton committed
20

Mark Otto's avatar
Mark Otto committed
21

Mark Otto's avatar
Mark Otto committed
22
23

## Versioning
Mark Otto's avatar
Mark Otto committed
24

25
For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.
Mark Otto's avatar
Mark Otto committed
26

Mark Otto's avatar
Mark Otto committed
27
Releases will be numbered with the following format:
Mark Otto's avatar
Mark Otto committed
28
29
30
31
32

`<major>.<minor>.<patch>`

And constructed with the following guidelines:

TJ Rana's avatar
TJ Rana committed
33
34
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
TJ Rana's avatar
TJ Rana committed
35
* Bug fixes and misc changes bumps the patch
Mark Otto's avatar
Mark Otto committed
36

Mark Otto's avatar
Mark Otto committed
37
For more information on SemVer, please visit [http://semver.org/](http://semver.org/).
Mark Otto's avatar
Mark Otto committed
38
39


Mark Otto's avatar
Mark Otto committed
40

Mark Otto's avatar
Mark Otto committed
41
## Bug tracker
Mark Otto's avatar
Mark Otto committed
42

Mark Otto's avatar
Mark Otto committed
43
Have a bug or a feature request? [Please open a new issue](https://github.com/twitter/bootstrap/issues). Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/necolas/issue-guidelines), written by [Nicolas Gallagher](https://github.com/necolas/).
44
45
46



Mark Otto's avatar
Mark Otto committed
47
## Community
48

Mark Otto's avatar
Mark Otto committed
49
Keep track of development and community news.
Jacob Thornton's avatar
Jacob Thornton committed
50

Mark Otto's avatar
Mark Otto committed
51
52
53
54
* Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap).
* Read and subscribe to the [The Official Twitter Bootstrap Blog](http://blog.getbootstrap.com).
* Have a question that's not a feature request or bug report? [Ask on the mailing list.](http://groups.google.com/group/twitter-bootstrap)
* Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel.
55

Chris Aniszczyk's avatar
Chris Aniszczyk committed
56

Jacob Thornton's avatar
Jacob Thornton committed
57

58
## Documentation
59

60
Bootstrap's docs are built using Jekyll and hosted on GitHub Pages at http://getbootstrap.com. To view our docs locally, you'll need to [install Jekyll](https://github.com/mojombo/jekyll/wiki/install) to run a local server.
61

62
63
64
65
66
67
68
Documentation for [previous versions](https://github.com/twitter/bootstrap/tags) is also available via tags.



## Compiling CSS and JavaScript

Bootstrap includes a makefile with convenient methods for working with the framework. Before getting started, be sure to install the necessary local dependencies:
69
70

```
71
$ npm install
72
73
```

74
75
76
77
Once installed, you'll be able to run the various make commands provided:

#### build - `make`
Runs the recess compiler to rebuild the `/less` files and compiles the docs. Requires recess and uglify-js.
78

79
#### test - `make test`
80
Runs jshint and qunit tests headlessly in [phantomjs](http://code.google.com/p/phantomjs/) (used for ci). Depends on having phantomjs installed.
81

82
#### watch - `make watch`
83
This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem.
Jacob Thornton's avatar
Jacob Thornton committed
84

Jacob Thornton's avatar
Jacob Thornton committed
85

Mark Otto's avatar
Mark Otto committed
86

Mark Otto's avatar
Mark Otto committed
87
88
89
## Contributing

Please submit all pull requests against *-wip branches. 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](http://github.com/mdo/code-guide), maintained by [Mark Otto](http://github.com/mdo).
Jacob Thornton's avatar
Jacob Thornton committed
90
91


Mark Otto's avatar
Mark Otto committed
92

Mark Otto's avatar
Mark Otto committed
93
## Authors
94

Mark Otto's avatar
Mark Otto committed
95
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
96

Mark Otto's avatar
Mark Otto committed
97
98
+ [http://twitter.com/mdo](http://twitter.com/mdo)
+ [http://github.com/mdo](http://github.com/mdo)
99

Mark Otto's avatar
Mark Otto committed
100
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
101

Mark Otto's avatar
Mark Otto committed
102
103
+ [http://twitter.com/fat](http://twitter.com/fat)
+ [http://github.com/fat](http://github.com/fat)
Mark Otto's avatar
Mark Otto committed
104

Mark Otto's avatar
Mark Otto committed
105

Mark Otto's avatar
Mark Otto committed
106

Mark Otto's avatar
Mark Otto committed
107
## Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
108

Mark Otto's avatar
Mark Otto committed
109
Copyright 2012 Twitter, Inc.
Jacob Thornton's avatar
Jacob Thornton committed
110

Mark Otto's avatar
Mark Otto committed
111
112
113
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this work except in compliance with the License.
You may obtain a copy of the License in the LICENSE file, or at:
Mark Otto's avatar
Mark Otto committed
114

Mark Otto's avatar
Mark Otto committed
115
  [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
116

Mark Otto's avatar
Mark Otto committed
117
118
119
120
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
121
limitations under the License.