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

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

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

Mark Otto's avatar
Mark Otto committed
21
    <link rel="stylesheet" type="text/css" href="bootstrap-1.0.0.css">
Jacob Thornton's avatar
Jacob Thornton committed
22
23
24

For more info, refer to the docs!

Mark Otto's avatar
Mark Otto committed
25

Jacob Thornton's avatar
Jacob Thornton committed
26
27
Reporting bugs
--------------
Jacob Thornton's avatar
Jacob Thornton committed
28

29
Please create an issue here on GitHub! :P
Jacob Thornton's avatar
Jacob Thornton committed
30

Jacob Thornton's avatar
Jacob Thornton committed
31
32
33
34
35
36

Google Group
------------

http://groups.google.com/group/twitter-bootstrap

37
38
39
40
41
42
43
44
45
46
47
48
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
49

Jacob Thornton's avatar
Jacob Thornton committed
50
51
AUTHORS
-------
52

Mark Otto's avatar
Mark Otto committed
53
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
54
55
56

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

Mark Otto's avatar
Mark Otto committed
58
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
59
60
61

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

Mark Otto's avatar
Mark Otto committed
63

Jacob Thornton's avatar
Jacob Thornton committed
64
65
Copyright and License
---------------------
Jacob Thornton's avatar
Jacob Thornton committed
66
67
68

Copyright 2011 Twitter, Inc.

Mark Otto's avatar
Mark Otto committed
69
70
71
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
72

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

Mark Otto's avatar
Mark Otto committed
75
76
77
78
79
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
limitations under the License.