README.md 2.89 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
2
TWITTER BOOTSTRAP
=================
Jacob Thornton's avatar
Jacob Thornton committed
3

Mark Otto's avatar
Mark Otto committed
4
Bootstrap is Twitter's toolkit for kickstarting CSS for websites, apps, and more. It includes base CSS styles for typography, forms, buttons, tables, grids, navigation, alerts, and more.
5

Jacob Thornton's avatar
Jacob Thornton committed
6
To get started -- checkout http://twitter.github.com/bootstrap!
Jacob Thornton's avatar
Jacob Thornton committed
7

Mark Otto's avatar
Mark Otto committed
8

Jacob Thornton's avatar
Jacob Thornton committed
9
10
Usage
-----
Jacob Thornton's avatar
Jacob Thornton committed
11

Mark Otto's avatar
Mark Otto committed
12
You can use Twitter Bootstrap in one of two ways: just drop the compiled CSS into any new project and start cranking, or run LESS on your site and compile on the fly like a boss.
Jacob Thornton's avatar
Jacob Thornton committed
13

Mark Otto's avatar
Mark Otto committed
14
Here's what the LESS version looks like:
Jacob Thornton's avatar
Jacob Thornton committed
15

16
17
18
19
``` html
<link rel="stylesheet/less" type="text/css" href="lib/bootstrap.less">
<script src="less.js" type="text/javascript"></script>
```
Jacob Thornton's avatar
Jacob Thornton committed
20

Mark Otto's avatar
Mark Otto committed
21
Or if you prefer, the standard css way:
Jacob Thornton's avatar
Jacob Thornton committed
22

23
24
25
``` html
<link rel="stylesheet" type="text/css" href="bootstrap-1.2.0.css">
```
Jacob Thornton's avatar
Jacob Thornton committed
26
27
28

For more info, refer to the docs!

Mark Otto's avatar
Mark Otto committed
29

Mark Otto's avatar
Mark Otto committed
30
31
32
33
34
35
36
37
38
39
40
41
Versioning
----------

For transparency and insight into our release cycle, and for striving to maintain backwards compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the follow format:

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

And constructed with the following guidelines:

* Breaking backwards compatibility bumps the major
42
* New additions without breaking backwards compatibility bumps the minor
Mark Otto's avatar
Mark Otto committed
43
44
45
46
47
* Bug fixes and misc changes bump the patch

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


48
Bug Tracker
Jacob Thornton's avatar
Jacob Thornton committed
49
-----------
Jacob Thornton's avatar
Jacob Thornton committed
50

51
Have a bug? Please create an issue here on GitHub!
Jacob Thornton's avatar
Jacob Thornton committed
52

53
https://github.com/twitter/bootstrap/issues
Jacob Thornton's avatar
Jacob Thornton committed
54

55
56

Mailing List
Jacob Thornton's avatar
Jacob Thornton committed
57
58
------------

59
60
61
Have a question? Ask on our mailing list!

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

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

Jacob Thornton's avatar
Jacob Thornton committed
65

66
67
68
69
70
71
72
73
74
75
76
77
Developers
----------

We have included a makefile with convenience methods for working with the bootstrap library.

+ **build** - `make build`
This will run the less compiler on the bootstrap lib and generate a bootstrap.css and bootstrap.min.css file.
The lessc compiler is required for this command to run.

+ **watch** - `make watch`
This is a convenience method for watching your less files and automatically building them whenever you save.
Watchr is required for this command to run.
Jacob Thornton's avatar
Jacob Thornton committed
78

Jacob Thornton's avatar
Jacob Thornton committed
79

Jacob Thornton's avatar
Jacob Thornton committed
80
81
AUTHORS
-------
82

Mark Otto's avatar
Mark Otto committed
83
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
84
85
86

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

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

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

Mark Otto's avatar
Mark Otto committed
93

Jacob Thornton's avatar
Jacob Thornton committed
94
95
Copyright and License
---------------------
Jacob Thornton's avatar
Jacob Thornton committed
96
97
98

Copyright 2011 Twitter, Inc.

Mark Otto's avatar
Mark Otto committed
99
100
101
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
102

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

Mark Otto's avatar
Mark Otto committed
105
106
107
108
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
109
limitations under the License.