From: Alex Kalicki Date: Sun, 29 Sep 2013 22:17:46 +0000 (-0400) Subject: Added abridged form of 'What's included' docs to README X-Git-Tag: v3.0.1~39^2~108^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e21c744a57d4bcfadd6aac61d88d849d683e44c9;p=thirdparty%2Fbootstrap.git Added abridged form of 'What's included' docs to README --- diff --git a/README.md b/README.md index d55d5c2dae..6194fdc05c 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,29 @@ Three quick start options are available: * Clone the repo: `git clone git://github.com/twbs/bootstrap.git`. * Install with [Bower](http://bower.io): `bower install bootstrap`. +### 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. + Read the [Getting Started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.