aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Kalicki <[email protected]>2013-09-29 18:17:46 -0400
committerAlex Kalicki <[email protected]>2013-09-29 18:17:46 -0400
commite21c744a57d4bcfadd6aac61d88d849d683e44c9 (patch)
treeaa2ef5faa3c6ca7705ffb8a9c0b6c5bc965c59b6 /README.md
parent1809894e8a6e82e4871cbb399fc15c7dee306605 (diff)
downloadbootstrap-e21c744a57d4bcfadd6aac61d88d849d683e44c9.tar.xz
bootstrap-e21c744a57d4bcfadd6aac61d88d849d683e44c9.zip
Added abridged form of 'What's included' docs to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index d55d5c2da..6194fdc05 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.