]> git.ipfire.org Git - thirdparty/bootstrap.git/commitdiff
Added abridged form of 'What's included' docs to README
authorAlex Kalicki <alexander.kalicki@gmail.com>
Sun, 29 Sep 2013 22:17:46 +0000 (18:17 -0400)
committerAlex Kalicki <alexander.kalicki@gmail.com>
Sun, 29 Sep 2013 22:17:46 +0000 (18:17 -0400)
README.md

index d55d5c2dae34ee6e58950c7540bf27b0c76596fc..6194fdc05ce4f18a59f855e4433d60793aeaa579 100644 (file)
--- 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.