Repository files navigation

Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created and maintained byMark Otto andJacob Thornton.

To get started, check outhttp://getbootstrap.com!

Three quick start options are available:

• Download the latest release.
• Clone the repo:git clone git://github.com/twbs/bootstrap.git.
• Install withBower:bower install bootstrap.

Read theGetting Started page for information on the framework contents, templates and examples, and more.

Have a bug or a feature request?Please open a new issue. Before opening any issue, please search for existing issues and read theIssue Guidelines, written byNicolas Gallagher.

Bootstrap's documentation, included in this repo in the root directory, is built withJekyll and publicly hosted on GitHub Pages athttp://getbootstrap.com. The docs may also be run locally.

1. If necessary,install Jekyll (requires v1.x).
2. From the root/bootstrap directory, runjekyll serve in the command line.

• Windows users: runchcp 65001 first to change the command prompt's character encoding (code page) to UTF-8 so Jekyll runs without errors.

3. Openhttp://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading theirdocumentation.

Documentation for v2.3.2 has been made available for the time being athttp://getbootstrap.com/2.3.2/ while folks transition to Bootstrap 3.

Previous releases and their documentation are also available for download.

Bootstrap usesGrunt with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Grunt commands.

From the command line:

1. Installgrunt-cli globally withnpm install -g grunt-cli.
2. Install thenecessary local dependencies vianpm install

When completed, you'll be able to run the various Grunt commands provided from the command line.

Unfamiliar withnpm? Don't have node installed? That's a-okay. npm stands fornode packaged modules and is a way to manage development dependencies through node.js.Download and install node.js before proceeding.

Rungrunt to run tests locally and compile the CSS and JavaScript into/dist.Requiresrecess anduglify-js.

grunt dist creates the/dist directory with compiled files.Requiresrecess anduglify-js.

Runs jshint and qunit tests headlessly inphantomjs (used for CI).Requiresphantomjs.

This is a convenience method for watching just Less files and automatically building them whenever you save.

Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerunnpm install.

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 theCode Guide, maintained byMark Otto.

Editor preferences are available in theeditor config for easy use in common text editors. Read more and download plugins athttp://editorconfig.org.

Keep track of development and community news.

• Follow@twbootstrap on Twitter.
• Read and subscribe to theThe Official Bootstrap Blog.
• Have a question that's not a feature request or bug report?Ask on the mailing list.
• Chat with fellow Bootstrappers in IRC. On theirc.freenode.net server, in the##twitter-bootstrap channel.

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 visithttp://semver.org/.

Mark Otto

• http://twitter.com/mdo
• http://github.com/mdo

Jacob Thornton

• http://twitter.com/fat
• http://github.com/fat

Copyright 2012 Twitter, Inc underthe Apache 2.0 license.