]> git.ipfire.org Git - thirdparty/bootstrap.git/commitdiff
Fixes #10716: Update what's included docs to add info on both download options
authorMark Otto <otto@github.com>
Sun, 1 Dec 2013 05:05:39 +0000 (21:05 -0800)
committerMark Otto <otto@github.com>
Sun, 1 Dec 2013 05:05:39 +0000 (21:05 -0800)
_includes/nav-getting-started.html
getting-started.html

index 243c05fb05175f064bfd34a90076761946351d75..ce7a718d6625e3bec3418f1d244b4b72ca2191d8 100644 (file)
@@ -8,6 +8,10 @@
 </li>
 <li>
   <a href="#whats-included">What's included</a>
+  <ul class="nav">
+    <li><a href="#whats-included-precompiled">Precompiled</a></li>
+    <li><a href="#whats-included-source">Source code</a></li>
+  </ul>
 </li>
 <li>
   <a href="#template">Basic template</a>
index 880d2ee483018a383d6877bb27c86451b09b9c2b..b65fc497f1aced124e6555e8409c1b43253448c8 100644 (file)
@@ -62,9 +62,15 @@ base_url: "../"
     <div class="page-header">
       <h1 id="whats-included">What's included</h1>
     </div>
-    <p class="lead">Within the download you'll find the following directories and files, logically grouping common resources and providing both compiled and minified variations.</p>
-    <p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p>
+    <p class="lead">Bootstrap is downloadable in two forms, within which you'll find the following directories and files, logically grouping common resources and providing both compiled and minified variations.</p>
 
+    <div class="bs-callout bs-callout-warning" id="jquery-required">
+      <h4>jQuery required</h4>
+      <p>Please note that <strong>all JavaScript plugins require jQuery</strong> to be included, as shown in the <a href="#template">starter template</a>. <a href="{{ site.repo }}/blob/v{{ site.current_version }}/bower.json">Consult our <code>bower.json</code></a> to see which versions of jQuery are supported.</p>
+    </div>
+
+    <h2 id="whats-included-precompiled">Precompiled Bootstrap</h2>
+    <p>Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:</p>
 <!-- NOTE: This info is intentionally duplicated in the README.
 Copy any changes made here over to the README too. -->
 {% highlight bash %}
@@ -85,11 +91,24 @@ bootstrap/
 {% endhighlight %}
 
     <p>This is the most basic form of Bootstrap: precompiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (<code>bootstrap.*</code>), as well as compiled and minified CSS and JS (<code>bootstrap.min.*</code>). Fonts from Glyphicons are included, as is the optional Bootstrap theme.</p>
-    <div class="bs-callout bs-callout-danger" id="jquery-required">
-      <h4>jQuery required</h4>
-      <p>Please note that <strong>all JavaScript plugins require jQuery</strong> to be included, as shown in the <a href="#template">starter template</a>. <a href="{{ site.repo }}/blob/v{{ site.current_version }}/bower.json">Consult our <code>bower.json</code></a> to see which versions of jQuery are supported.</p>
-    </div>
+
+    <h2 id="whats-included-source">Bootstrap source code</h2>
+    <p>The Bootstrap source code download includes the precompiled CSS, JavaScript, and font assets, along with source LESS, JavaScript, and documentation. More specifically, it includes the following and more:</p>
+{% highlight bash %}
+bootstrap/
+├── less/
+├── js/
+├── fonts/
+├── dist/
+│   ├── css/
+│   ├── js/
+│   └── fonts/
+├── docs-assets/
+├── examples/
+└── *.html
+{% endhighlight %}
   </div>
+  <p>The <code>less/</code>, <code>js/</code>, and <code>fonts/</code> are the source code for our CSS, JS, and icon fonts (respectively). The <code>dist/</code> folder includes everything listed in the precompiled download section above. <code>docs-assets/</code>, <code>examples/</code>, and all <code>*.html</code> files are for our documentation. Beyond that, any other included file provides support for packages, license information, and development.</p>
 
 
   <!-- Template