aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2013-09-30 17:15:15 -0700
committerMark Otto <[email protected]>2013-09-30 17:15:15 -0700
commit0e628b65467f82d069df42f71a9c6c98be7bfd22 (patch)
treea5dbb826d4f72d33fd2d6a74d2109bffbc822094
parentef66c31dd457b1faecd51410eae1d9b5d3a0b9aa (diff)
parent80d74c1bf708bf6821c8f326e80b5640fb112893 (diff)
downloadbootstrap-0e628b65467f82d069df42f71a9c6c98be7bfd22.tar.xz
bootstrap-0e628b65467f82d069df42f71a9c6c98be7bfd22.zip
Merge pull request #10864 from akalicki/included_files
Added abridged form of 'What's included' docs to README
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index d55d5c2da..bb49a7317 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,29 @@ Three quick start options are available:
Read the [Getting Started page](http://getbootstrap.com/getting-started/) 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