README.md 2.51 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

Mark Otto's avatar
Mark Otto committed
9
10
11
12
13
14
15
16
17
18
19
20
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
21
* New additions without breaking backwards compatibility bumps the minor
Mark Otto's avatar
Mark Otto committed
22
23
24
25
26
* 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
27
Bug tracker
Jacob Thornton's avatar
Jacob Thornton committed
28
-----------
Jacob Thornton's avatar
Jacob Thornton committed
29

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

32
https://github.com/twitter/bootstrap/issues
Jacob Thornton's avatar
Jacob Thornton committed
33

34

Mark Otto's avatar
Mark Otto committed
35
36
37
Twitter account
---------------

Mark Otto's avatar
Mark Otto committed
38
Keep up to date on announcements and more by following Bootstrap on Twitter, <a href="http://twitter.com/TwBootstrap">@TwBootstrap</a>.
Mark Otto's avatar
Mark Otto committed
39
40
41


Mailing list
Jacob Thornton's avatar
Jacob Thornton committed
42
43
------------

44
45
46
Have a question? Ask on our mailing list!

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

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

Jacob Thornton's avatar
Jacob Thornton committed
50

51
52
53
Developers
----------

54
We have included a makefile with convenience methods for working with the Bootstrap library.
55

Jacob Thornton's avatar
Jacob Thornton committed
56
57
+ **build** - `make`
This will run the less compiler on the bootstrap lib and regenerate the docs dir.
58
59
60
61
62
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
63

Jacob Thornton's avatar
Jacob Thornton committed
64

Mark Otto's avatar
Mark Otto committed
65
Authors
Jacob Thornton's avatar
Jacob Thornton committed
66
-------
67

Mark Otto's avatar
Mark Otto committed
68
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
69
70
71

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

Mark Otto's avatar
Mark Otto committed
73
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
74
75
76

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

Mark Otto's avatar
Mark Otto committed
78

Mark Otto's avatar
Mark Otto committed
79
Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
80
---------------------
Jacob Thornton's avatar
Jacob Thornton committed
81

Mark Otto's avatar
Mark Otto committed
82
Copyright 2012 Twitter, Inc.
Jacob Thornton's avatar
Jacob Thornton committed
83

Mark Otto's avatar
Mark Otto committed
84
85
86
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
87

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

Mark Otto's avatar
Mark Otto committed
90
91
92
93
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
94
limitations under the License.