README.md 3.95 KB
Newer Older
Chris Aniszczyk's avatar
Chris Aniszczyk committed
1
[Twitter Bootstrap](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
=================
Jacob Thornton's avatar
Jacob Thornton committed
3

Mark Otto's avatar
Mark Otto committed
4
5
6
7
8
9
10
11
12
Bootstrap provides simple and flexible HTML, CSS, and Javascript for popular user interface components and interactions. In other words, it's a front-end toolkit for faster, more beautiful web development. It's created and maintained by [Mark Otto](http://twitter.com/mdo) and [Jacob Thornton](http://twitter.com/fat) at Twitter.

To get started, checkout http://twitter.github.com/bootstrap!



Quick start
-----------

Mark Otto's avatar
Mark Otto committed
13
Clone the repo, `git clone git://github.com/twitter/bootstrap.git`, or [download the latest release](https://github.com/twitter/bootstrap/zipball/master).
14

Jacob Thornton's avatar
Jacob Thornton committed
15

Mark Otto's avatar
Mark Otto committed
16

Mark Otto's avatar
Mark Otto committed
17
18
19
Versioning
----------

20
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
21
22
23
24
25
26
27

Releases will be numbered with the follow format:

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

And constructed with the following guidelines:

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

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


Mark Otto's avatar
Mark Otto committed
35

Mark Otto's avatar
Mark Otto committed
36
Bug tracker
Jacob Thornton's avatar
Jacob Thornton committed
37
-----------
Jacob Thornton's avatar
Jacob Thornton committed
38

Jacob Thornton's avatar
Jacob Thornton committed
39
Have a bug? Please create an issue here on GitHub! Also, when filing please make sure you're familiar with [necolas's guidelines](https://github.com/necolas/issue-guidelines). thanks! <3
Jacob Thornton's avatar
Jacob Thornton committed
40

41
https://github.com/twitter/bootstrap/issues
Jacob Thornton's avatar
Jacob Thornton committed
42

43

Mark Otto's avatar
Mark Otto committed
44

Mark Otto's avatar
Mark Otto committed
45
46
47
Twitter account
---------------

Mark Otto's avatar
Mark Otto committed
48
49
Keep up to date on announcements and more by following Bootstrap on Twitter, [@TwBootstrap](http://twitter.com/TwBootstrap).

Mark Otto's avatar
Mark Otto committed
50
51


52
53
54
55
56
57
58
Blog
----

Read more detailed announcements, discussions, and more on [The Official Twitter Bootstrap Blog](http://blog.getbootstrap.com).



Mark Otto's avatar
Mark Otto committed
59
Mailing list
Jacob Thornton's avatar
Jacob Thornton committed
60
61
------------

62
63
64
Have a question? Ask on our mailing list!

twitter-bootstrap@googlegroups.com
Chris Aniszczyk's avatar
Chris Aniszczyk committed
65

Jacob Thornton's avatar
Jacob Thornton committed
66
67
http://groups.google.com/group/twitter-bootstrap

Jacob Thornton's avatar
Jacob Thornton committed
68

Mark Otto's avatar
Mark Otto committed
69

Jacob Thornton's avatar
Jacob Thornton committed
70
71
72
73
IRC
---

Server: irc.freenode.net
Jacob Thornton's avatar
Jacob Thornton committed
74

Jacob Thornton's avatar
Jacob Thornton committed
75
76
77
Channel: ##twitter-bootstrap (the double ## is not a typo)


Mark Otto's avatar
Mark Otto committed
78

79
80
81
Developers
----------

82
We have included a makefile with convenience methods for working with the Bootstrap library.
83

84
+ **dependencies**
85
Our makefile depends on you having recess, uglify.js, and jshint installed. To install, just run the following command in npm:
86
87

```
88
$ npm install recess uglify-js jshint -g
89
90
```

Jacob Thornton's avatar
Jacob Thornton committed
91
+ **build** - `make`
92
Runs the recess compiler to rebuild the `/less` files and compiles the docs pages. Requires recess and uglify-js. <a href="http://twitter.github.com/bootstrap/less.html#compiling">Read more in our docs &raquo;</a>
93

94
95
96
+ **test** - `make test`
Runs jshint and qunit tests headlessly in phantom js (used for ci). Depends on having phatomjs installed.

97
+ **watch** - `make watch`
98
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
99

Jacob Thornton's avatar
Jacob Thornton committed
100

Jacob Thornton's avatar
Jacob Thornton committed
101
102
103
104
105
Contributing
------------

Please make all pull requests against wip-* branches. Also, if your unit test contains javascript patches or features - you must include relevant unit tests. Thanks!

Mark Otto's avatar
Mark Otto committed
106

Mark Otto's avatar
Mark Otto committed
107
Authors
Jacob Thornton's avatar
Jacob Thornton committed
108
-------
109

Mark Otto's avatar
Mark Otto committed
110
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
111
112
113

+ http://twitter.com/mdo
+ http://github.com/markdotto
114

Mark Otto's avatar
Mark Otto committed
115
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
116
117
118

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

Mark Otto's avatar
Mark Otto committed
120

Mark Otto's avatar
Mark Otto committed
121

Mark Otto's avatar
Mark Otto committed
122
Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
123
---------------------
Jacob Thornton's avatar
Jacob Thornton committed
124

Mark Otto's avatar
Mark Otto committed
125
Copyright 2012 Twitter, Inc.
Jacob Thornton's avatar
Jacob Thornton committed
126

Mark Otto's avatar
Mark Otto committed
127
128
129
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
130

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

Mark Otto's avatar
Mark Otto committed
133
134
135
136
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
137
limitations under the License.