mirror of https://github.com/twbs/bootstrap.git synced 2024-12-10 22:24:19 +01:00

The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web. http://getbootstrap.com

Go to file

Chris Rebert ae80cdca24 Revert "Temporarily revert README deletions from #13470," This reverts commit `54284a13c6`.		2014-05-12 12:58:47 -07:00
dist	grunt dist	2014-05-08 16:35:03 -07:00
docs	Update html5shiv to 3.7.2.	2014-05-10 09:23:53 +03:00
fonts	Remove execute permission on font files	2014-02-11 07:57:31 +01:00
grunt	JS: remove unused variables.	2014-04-09 10:01:48 +03:00
js	Fixed affix-bottom positioning	2014-05-09 00:26:31 +02:00
less	Squashed commit of the following:	2014-05-10 17:39:34 +01:00
test-infra	unlock & bump grunt-jscs-checker to ~0.4.3	2014-05-07 13:28:02 -07:00
_config.yml	include RTL CSS CDN URL in Download docs	2014-05-04 02:09:34 -07:00
.editorconfig	Don't re-set indent style for [*.py]	2014-02-01 14:37:19 +01:00
.gitattributes	Use LF for SVG files too.	2014-03-07 10:20:38 +02:00
.gitignore	need customize.js to be tracked for it to work on GitHub Pages	2013-12-06 11:35:58 -08:00
.travis.yml	Update .travis.yml	2014-05-07 23:37:41 -07:00
bower.json	added bower reference to main less file	2014-04-11 14:49:52 -07:00
CNAME	add cname	2013-07-26 23:04:03 -07:00
composer.json	Update composer.json	2014-04-20 22:45:21 +03:00
CONTRIBUTING.md	Add autoprefixer	2014-03-07 09:01:54 +01:00
Gruntfile.js	add IE warning scripts to linter config	2014-04-24 19:14:06 -07:00
LICENSE	missed a file	2014-01-07 01:22:13 +01:00
package.json	unlock & bump grunt-jscs-checker to ~0.4.3	2014-05-07 13:28:02 -07:00
README.md	Revert "Temporarily revert README deletions from #13470,"	2014-05-12 12:58:47 -07:00

README.md

Bootstrap

Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by Mark Otto and Jacob Thornton, and maintained by the core team with the massive support and involvement of the community.

To get started, check out http://getbootstrap.com!

Quick start
Bugs and feature requests
Documentation
Contributing
Community
Versioning
Authors
Copyright and license

Quick start

Three quick start options are available:

Download the latest release.
Clone the repo: git clone https://github.com/twbs/bootstrap.git.
Install with Bower: bower install bootstrap.

Read the Getting started page for information on the framework contents, templates and examples, and more.

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.min.css
│   ├── bootstrap-theme.css
│   └── bootstrap-theme.min.css
├── js/
│   ├── bootstrap.js
│   └── bootstrap.min.js
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    └── glyphicons-halflings-regular.woff

We provide compiled CSS and JS (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). Fonts from Glyphicons are included, as is the optional Bootstrap theme.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

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

Running documentation locally

If necessary, install Jekyll (requires v1.5.x).

Windows users: Read this unofficial guide to get Jekyll up and running without problems. We use Pygments for syntax highlighting, so make sure to read the sections on installing Python and Pygments.

From the root /bootstrap directory, run jekyll serve in the command line.
Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Documentation for previous releases

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

Previous releases and their documentation are also available for download.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, 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, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Community

Keep track of development and community news.

Follow @twbootstrap on Twitter.
Read and subscribe to The Official Bootstrap Blog.
Chat with fellow Bootstrappers in IRC. On the irc.freenode.net server, in the ##twitter-bootstrap channel.
Implementation help may be found at Stack Overflow (tagged twitter-bootstrap-3).

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to these rules whenever possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

Breaking backward compatibility bumps the major while resetting minor and patch
New additions without breaking backward compatibility bumps the minor while resetting the patch
Bug fixes and misc changes bumps only the patch

For more information on SemVer, please visit http://semver.org/.

Creators

Mark Otto

Jacob Thornton