README.md 4.79 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://getbootstrap.com) [![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

21
22
Read the [Getting Started page](http://getbootstrap.com/getting-started/) for information on the framework contents, basic template guidelines, and more.

Mark Otto's avatar
Mark Otto committed
23

Mark Otto's avatar
Mark Otto committed
24
25

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

27
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
28

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

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

And constructed with the following guidelines:

TJ Rana's avatar
TJ Rana committed
35
36
* 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
37
* Bug fixes and misc changes bumps the patch
Mark Otto's avatar
Mark Otto committed
38

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


Mark Otto's avatar
Mark Otto committed
42

Mark Otto's avatar
Mark Otto committed
43
## Bugs and feature requests
Mark Otto's avatar
Mark Otto committed
44

Mark Otto's avatar
Mark Otto committed
45
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/).
46
47
48



Mark Otto's avatar
Mark Otto committed
49
## Community
50

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

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

Chris Aniszczyk's avatar
Chris Aniszczyk committed
58

Jacob Thornton's avatar
Jacob Thornton committed
59

60
## Documentation
61

Mark Otto's avatar
Mark Otto committed
62
Bootstrap's docs are built using [Jekyll](http://jekyllrb.com) and hosted on GitHub Pages at [http://getbootstrap.com](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.
63

64
65
66
67
68
69
70
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:
71
72

```
73
$ npm install
74
75
```

76
77
78
79
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.
80

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

84
#### watch - `make watch`
85
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
86

Jacob Thornton's avatar
Jacob Thornton committed
87

Mark Otto's avatar
Mark Otto committed
88

Mark Otto's avatar
Mark Otto committed
89
90
91
## 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
92
93


Mark Otto's avatar
Mark Otto committed
94

Mark Otto's avatar
Mark Otto committed
95
## Authors
96

Mark Otto's avatar
Mark Otto committed
97
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
98

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

Mark Otto's avatar
Mark Otto committed
102
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
103

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

Mark Otto's avatar
Mark Otto committed
107

Mark Otto's avatar
Mark Otto committed
108

Mark Otto's avatar
Mark Otto committed
109
## Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
110

Mark Otto's avatar
Mark Otto committed
111
Copyright 2012 Twitter, Inc.
Jacob Thornton's avatar
Jacob Thornton committed
112

Mark Otto's avatar
Mark Otto committed
113
114
115
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
116

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

Mark Otto's avatar
Mark Otto committed
119
120
121
122
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
123
limitations under the License.