mirror of
https://github.com/twbs/bootstrap.git
synced 2022-11-09 12:25:43 -05:00
133 lines
5.4 KiB
Markdown
133 lines
5.4 KiB
Markdown
# [Bootstrap v3.0.0](http://getbootstrap.com) [](http://travis-ci.org/twitter/bootstrap)
|
|
|
|
Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created and maintained by [Mark Otto](http://twitter.com/mdo) and [Jacob Thornton](http://twitter.com/fat).
|
|
|
|
To get started, check out [http://getbootstrap.com](http://getbootstrap.com)!
|
|
|
|
|
|
|
|
## Quick start
|
|
|
|
Three quick start options are available:
|
|
|
|
* [Download the latest release](https://github.com/twitter/bootstrap/zipball/master).
|
|
* Clone the repo: `git clone git://github.com/twitter/bootstrap.git`.
|
|
* Install with [Bower](http://bower.io): `bower install bootstrap`.
|
|
|
|
Read the [Getting Started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
|
|
|
|
|
|
|
|
## Bugs and feature requests
|
|
|
|
Have a bug or a feature request? [Please open a new issue](https://github.com/twitter/bootstrap/issues). Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/necolas/issue-guidelines), written by [Nicolas Gallagher](https://github.com/necolas/).
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
Bootstrap's documentation, included in this repo in the `/docs` directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at [http://getbootstrap.com](http://getbootstrap.com). The docs maybe also be run locally.
|
|
|
|
### Running documentation locally
|
|
|
|
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v1.x).
|
|
2. From the `/bootstrap` directory, run `jekyll serve` in the command line.
|
|
3. Open [http://localhost:9001](http://localhost:9001) in your browser, and voilà.
|
|
|
|
Learn more about using Jekyll by reading their [documentation](http://jekyllrb.com/docs/home/).
|
|
|
|
### Documentation for previous releases
|
|
|
|
Documentation for v2.3.2 has been made available for the time being at [http://getbootstrap.com/2.3.2/docs](http://getbootstrap.com/2.3.2/docs) while folks transition to Bootstrap 3.
|
|
|
|
[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
|
|
|
|
|
|
|
|
## Compiling CSS and JavaScript
|
|
|
|
Bootstrap includes a [makefile](Makefile) with convenient methods for working with the framework. Before getting started, install [the necessary local dependencies](package.json):
|
|
|
|
```
|
|
$ npm install
|
|
```
|
|
|
|
When completed, you'll be able to run the various make commands provided.
|
|
|
|
### Available makefile commands
|
|
|
|
#### Build - `make`
|
|
`make` runs the Recess compiler to rebuild the `/less` files and compile the docs. **Requires recess and uglify-js.**
|
|
|
|
#### Compile CSS, JS, and fonts - `make bootstrap`
|
|
`make bootstrap` creates the `/bootstrap` directory with compiled files. **Requires recess and uglify-js.**
|
|
|
|
#### Tests - `make test`
|
|
Runs jshint and qunit tests headlessly in [phantomjs](http://code.google.com/p/phantomjs/) (used for ci). **Requires phantomjs.**
|
|
|
|
#### Watch - `make watch`
|
|
This is a convenience method for watching just Less files and automatically building them whenever you save. **Requires the watchr gem.**
|
|
|
|
### Troubleshooting dependencies
|
|
|
|
Should you encounter problems with installing dependencies or running makefile commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install`.
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
Please read through our guidelines for contributing to Bootstrap. Included are directions for opening issues, coding standards, and notes on development.
|
|
|
|
More over, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the [Code Guide](http://github.com/mdo/code-guide), maintained by [Mark Otto](http://github.com/mdo).
|
|
|
|
Editor preferences are available in the [editor config](.editorconfig) for easy use in common text editors. Read more and download plugins at [http://editorconfig.org](http://editorconfig.org).
|
|
|
|
|
|
|
|
## Community
|
|
|
|
Keep track of development and community news.
|
|
|
|
* Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap).
|
|
* Read and subscribe to the [The Official Twitter Bootstrap Blog](http://blog.getbootstrap.com).
|
|
* Have a question that's not a feature request or bug report? [Ask on the mailing list.](http://groups.google.com/group/twitter-bootstrap)
|
|
* Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel.
|
|
|
|
|
|
|
|
|
|
## Versioning
|
|
|
|
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.
|
|
|
|
Releases will be numbered with the following format:
|
|
|
|
`<major>.<minor>.<patch>`
|
|
|
|
And constructed with the following guidelines:
|
|
|
|
* Breaking backward compatibility bumps the major (and resets the minor and patch)
|
|
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
|
|
* Bug fixes and misc changes bumps the patch
|
|
|
|
For more information on SemVer, please visit [http://semver.org/](http://semver.org/).
|
|
|
|
|
|
|
|
## Authors
|
|
|
|
**Mark Otto**
|
|
|
|
+ [http://twitter.com/mdo](http://twitter.com/mdo)
|
|
+ [http://github.com/mdo](http://github.com/mdo)
|
|
|
|
**Jacob Thornton**
|
|
|
|
+ [http://twitter.com/fat](http://twitter.com/fat)
|
|
+ [http://github.com/fat](http://github.com/fat)
|
|
|
|
|
|
|
|
## Copyright and license
|
|
|
|
Copyright 2012 Twitter, Inc under [the Apache 2.0 license](LICENSE).
|