README.md 3 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
[Twitter Bootstrap](http://twitter.github.com/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
13
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
-----------

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:

28
29
* Breaking backward compatibility bumps the major
* New additions without breaking backward compatibility bumps the minor
Mark Otto's avatar
Mark Otto committed
30
31
32
33
34
* Bug fixes and misc changes bump the patch

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

39
Have a bug? Please create an issue here on GitHub!
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


Mailing list
Jacob Thornton's avatar
Jacob Thornton committed
53
54
------------

55
56
57
Have a question? Ask on our mailing list!

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

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

Jacob Thornton's avatar
Jacob Thornton committed
61

Mark Otto's avatar
Mark Otto committed
62

Jacob Thornton's avatar
Jacob Thornton committed
63
64
65
66
IRC
---

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

Jacob Thornton's avatar
Jacob Thornton committed
68
69
70
Channel: ##twitter-bootstrap (the double ## is not a typo)


Mark Otto's avatar
Mark Otto committed
71

72
73
74
Developers
----------

75
We have included a makefile with convenience methods for working with the Bootstrap library.
76

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

+ **watch** - `make watch`
81
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
82

Jacob Thornton's avatar
Jacob Thornton committed
83

Mark Otto's avatar
Mark Otto committed
84

Mark Otto's avatar
Mark Otto committed
85
Authors
Jacob Thornton's avatar
Jacob Thornton committed
86
-------
87

Mark Otto's avatar
Mark Otto committed
88
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
89
90
91

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

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

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

Mark Otto's avatar
Mark Otto committed
98

Mark Otto's avatar
Mark Otto committed
99

Mark Otto's avatar
Mark Otto committed
100
Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
101
---------------------
Jacob Thornton's avatar
Jacob Thornton committed
102

Mark Otto's avatar
Mark Otto committed
103
Copyright 2012 Twitter, Inc.
Jacob Thornton's avatar
Jacob Thornton committed
104

Mark Otto's avatar
Mark Otto committed
105
106
107
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
108

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

Mark Otto's avatar
Mark Otto committed
111
112
113
114
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
115
limitations under the License.