README.md 3.97 KB
Newer Older
1
# [Twitter 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
2

Mark Otto's avatar
Mark Otto committed
3
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
4

Mark Otto's avatar
Mark Otto committed
5
To get started, checkout http://getbootstrap.com!
Mark Otto's avatar
Mark Otto committed
6
7
8



Mark Otto's avatar
Mark Otto committed
9
## Quick start
Mark Otto's avatar
Mark Otto committed
10

Mark Otto's avatar
Mark Otto committed
11
Three quick start options are available:
12

Mark Otto's avatar
Mark Otto committed
13
14
15
* [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
16

Mark Otto's avatar
Mark Otto committed
17

Mark Otto's avatar
Mark Otto committed
18
19

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

21
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
22

Mark Otto's avatar
Mark Otto committed
23
Releases will be numbered with the following format:
Mark Otto's avatar
Mark Otto committed
24
25
26
27
28

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

And constructed with the following guidelines:

TJ Rana's avatar
TJ Rana committed
29
30
* 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
31
* Bug fixes and misc changes bumps the patch
Mark Otto's avatar
Mark Otto committed
32
33
34
35

For more information on SemVer, please visit http://semver.org/.


Mark Otto's avatar
Mark Otto committed
36

Mark Otto's avatar
Mark Otto committed
37
## Bug tracker
Mark Otto's avatar
Mark Otto committed
38

Mark Otto's avatar
Mark Otto committed
39
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/).
40
41
42



Mark Otto's avatar
Mark Otto committed
43
## Community
44

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

Mark Otto's avatar
Mark Otto committed
47
48
49
50
* 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.
51

Chris Aniszczyk's avatar
Chris Aniszczyk committed
52

Jacob Thornton's avatar
Jacob Thornton committed
53

Mark Otto's avatar
Mark Otto committed
54
## Developers
55

56
We have included a makefile with convenience methods for working with the Bootstrap library.
57

58
+ **dependencies**
59
Our makefile depends on you having recess, connect, uglify.js, and jshint installed. To install, just run the following command in npm:
60
61

```
62
$ npm install recess connect uglify-js jshint -g
63
64
```

Jacob Thornton's avatar
Jacob Thornton committed
65
+ **build** - `make`
66
Runs the recess compiler to rebuild the `/less` files and compiles the docs pages. Requires recess and uglify-js.
67

68
+ **test** - `make test`
69
Runs jshint and qunit tests headlessly in [phantomjs](http://code.google.com/p/phantomjs/) (used for ci). Depends on having phantomjs installed.
70

71
+ **watch** - `make watch`
72
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
73

Jacob Thornton's avatar
Jacob Thornton committed
74

Mark Otto's avatar
Mark Otto committed
75

Mark Otto's avatar
Mark Otto committed
76
77
78
## 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
79

Mark Otto's avatar
Mark Otto committed
80
Thanks!
Mark Otto's avatar
Mark Otto committed
81

Jacob Thornton's avatar
Jacob Thornton committed
82

Mark Otto's avatar
Mark Otto committed
83

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

Mark Otto's avatar
Mark Otto committed
86
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
87
88

+ http://twitter.com/mdo
Mark Otto's avatar
Mark Otto committed
89
+ http://github.com/mdo
90

Mark Otto's avatar
Mark Otto committed
91
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
92
93
94

+ http://twitter.com/fat
+ http://github.com/fat
Mark Otto's avatar
Mark Otto committed
95

Mark Otto's avatar
Mark Otto committed
96

Mark Otto's avatar
Mark Otto committed
97

Mark Otto's avatar
Mark Otto committed
98
## Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
99

Mark Otto's avatar
Mark Otto committed
100
Copyright 2012 Twitter, Inc.
Jacob Thornton's avatar
Jacob Thornton committed
101

Mark Otto's avatar
Mark Otto committed
102
103
104
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
105

Mark Otto's avatar
Mark Otto committed
106
   http://www.apache.org/licenses/LICENSE-2.0
107

Mark Otto's avatar
Mark Otto committed
108
109
110
111
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
112
limitations under the License.