twbs--bootstrap/README.md

116 lines
3.1 KiB
Markdown
Raw Normal View History

2011-07-29 21:28:37 +00:00
TWITTER BOOTSTRAP
=================
2011-07-29 21:24:27 +00:00
2011-07-29 19:30:59 +00:00
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.
2011-08-17 06:15:45 +00:00
To get started -- checkout http://twitter.github.com/bootstrap!
2011-08-17 06:14:09 +00:00
2011-06-29 14:54:55 +00:00
2011-07-29 21:24:27 +00:00
Usage
-----
2011-05-10 22:30:49 +00:00
2011-07-29 19:30:59 +00:00
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.
2011-05-10 22:30:49 +00:00
2011-06-29 14:54:55 +00:00
Here's what the LESS version looks like:
2011-05-10 22:30:49 +00:00
2011-09-12 04:56:54 +00:00
``` html
<link rel="stylesheet/less" type="text/css" href="lib/bootstrap.less">
<script src="less.js" type="text/javascript"></script>
```
2011-05-10 22:30:49 +00:00
Or if you prefer, the standard CSS way:
2011-05-10 22:30:49 +00:00
2011-09-12 04:56:54 +00:00
``` html
2011-09-16 19:30:30 +00:00
<link rel="stylesheet" type="text/css" href="bootstrap.css">
2011-09-12 04:56:54 +00:00
```
2011-05-10 22:30:49 +00:00
For more info, refer to the docs!
2011-06-29 14:54:55 +00:00
2011-08-30 04:26:53 +00:00
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
* New additions without breaking backwards compatibility bumps the minor
2011-08-30 04:26:53 +00:00
* Bug fixes and misc changes bump the patch
For more information on SemVer, please visit http://semver.org/.
2011-09-12 21:33:00 +00:00
Bug tracker
2011-08-19 18:25:19 +00:00
-----------
2011-05-10 22:30:49 +00:00
Have a bug? Please create an issue here on GitHub!
2011-05-10 22:30:49 +00:00
https://github.com/twitter/bootstrap/issues
2011-08-18 18:37:18 +00:00
2011-09-12 21:33:00 +00:00
Twitter account
---------------
2011-09-12 21:33:39 +00:00
Keep up to date on announcements and more by following Bootstrap on Twitter, <a href="http://twitter.com/TwBootstrap">@TwBootstrap</a>.
2011-09-12 21:33:00 +00:00
Mailing list
2011-08-18 18:37:18 +00:00
------------
Have a question? Ask on our mailing list!
twitter-bootstrap@googlegroups.com
2011-08-18 23:58:49 +00:00
2011-08-18 18:37:18 +00:00
http://groups.google.com/group/twitter-bootstrap
2011-08-19 18:25:19 +00:00
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.
2011-08-18 18:37:18 +00:00
2011-08-19 18:25:19 +00:00
2011-09-12 21:33:00 +00:00
Authors
2011-07-29 21:24:27 +00:00
-------
2011-04-28 06:12:49 +00:00
**Mark Otto**
2011-07-29 21:26:33 +00:00
+ http://twitter.com/mdo
+ http://github.com/markdotto
2011-07-29 19:30:59 +00:00
**Jacob Thornton**
2011-07-29 21:26:33 +00:00
+ http://twitter.com/fat
+ http://github.com/fat
2011-07-29 19:30:59 +00:00
2011-06-29 14:54:55 +00:00
2011-09-12 21:33:00 +00:00
Copyright and license
2011-07-29 21:24:27 +00:00
---------------------
2011-05-10 22:30:49 +00:00
Copyright 2011 Twitter, Inc.
2011-06-29 14:54:55 +00:00
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:
2011-04-28 06:12:49 +00:00
2011-06-29 14:54:55 +00:00
http://www.apache.org/licenses/LICENSE-2.0
2011-06-29 14:54:55 +00:00
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
2011-09-12 04:56:54 +00:00
limitations under the License.