]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
docs: merge CLI and template installations
authorNicolas Coden <nicolas@ncoden.fr>
Mon, 15 Jan 2018 22:49:31 +0000 (23:49 +0100)
committerNicolas Coden <nicolas@ncoden.fr>
Mon, 15 Jan 2018 22:49:31 +0000 (23:49 +0100)
docs/pages/installation.md

index b0966f90ef2fed53c8fc54fc430c269377124fef..6a4bb56830298a967b9d1a3ac097126b6efb7a9e 100644 (file)
@@ -112,78 +112,68 @@ npm install --global foundation-cli
 # or sudo npm install --global foundation-cli
 ```
 
-Then use to create a new Foundation project:
-
-```bash
-foundation new
-```
-
 <div class="callout info">
   Depending on how your machine is configured, the command may fail with an `EACCESS` error. To get around this, run the commands with `sudo` at the beginning.
 </div>
 
-<div class="callout info">
-  <p><strong>Foundation 5 users</strong>: if you already have the Foundation 5 CLI on your machine, you will only be able to access one of the commands, depending on how your command line environment is configured.</p>
-
-  <p>To remove the Foundation 5 CLI, run <code>gem uninstall foundation</code>. After testing this new CLI, if you want to go back to the old CLI. To remove the Foundation 6 CLI, run <code>npm uninstall foundation-cli --global</code>.</p>
-</div>
-
-
----
-
-## Install with a template
-
-### Basic Template
-
-The basic template includes Foundation and a build process for Sass.
-
-To manually set up [the basic template](https://github.com/zurb/foundation-sites-template):
+Then use to create a new Foundation project:
 
 ```bash
-# Download the template with Git
-git clone https://github.com/zurb/foundation-sites-template projectname
-
-# Move to the project folter, and install the needed dependencies
-cd projectname
-npm install
-
-# Build the Sass files
-npm start
+foundation new
 ```
 
-Your project will be recompiled every time you save a Sass file in `dist/.
+After you selected "Foundation for Sites", Foundation CLI will ask you which template you want to use. You can choose between:
 
+<div class="row">
+  <div class="column small-6">
+    <h3>Basic template</h3>
+    <p>
+      <b>Recommended for beginners</b><br>
+      A basic template to begin to use Foundation. It includes:
+      <ul>
+        <li>
+          Foundation for Sites pre-configured.
+        </li>
+        <li>
+          Sass compilation<br>
+          A tool to convert your SASS/SCSS files to CSS.
+        </li>
+        <li>
+          Starter HTML file<br>
+          A basic file to help you to use basic Foundation component (including the new XY grid !)
+        </li>
+      </ul>
+    </p>
+  </div>
 
-### ZURB Template
-
-The basic template includes Foundation and a build process with:
-* Handlebars HTML templates with Panini
-* Sass compilation and prefixing
-* JavaScript module bundling with webpack
-* Built-in BrowserSync
-* Production build with CSS, Javascript and Image compression
-
-To manually set up [the ZURB template](https://github.com/zurb/foundation-zurb-template):
-
-```bash
-# Download the ZURB template with Git
-git clone https://github.com/zurb/foundation-zurb-template projectname
-
-# Move to the project folter, and install the needed dependencies
-cd projectname
-npm install
+  <div class="column small-6">
+    <h3>ZURB template</h3>
+    <p>
+      <b>Recommended for experienced (or curious) users</b><br>
+      A more advanced project including Foundation and a build process with:
+      <ul>
+        <li>Handlebars HTML templates with Panini</li>
+        <li>Sass compilation and prefixing</li>
+        <li>JavaScript module bundling with webpack</li>
+        <li>Built-in BrowserSync</li>
+        <li>Production build with CSS, Javascript and Image compression</li>
+      </ul>
+    </p>
+  </div>
+</div>
 
-# Build the project
-npm start
-```
+<p class="text-center">
+  <a href="/starter-projects.html" class="button">See advanced Template installations</a>
+</p>
 
-Your finished site will be created in a folder called `dist.`, viewable at this URL: [http://localhost:8000](http://localhost:8000)
+<div class="callout info">
+  <p><strong>Foundation 5 users</strong>: if you already have the Foundation 5 CLI on your machine, you will only be able to access one of the commands, depending on how your command line environment is configured.</p>
 
-To create compressed, production-ready assets, run `npm run build`.
+  <p>To remove the Foundation 5 CLI, run <code>gem uninstall foundation</code>. After testing this new CLI, if you want to go back to the old CLI. To remove the Foundation 6 CLI, run <code>npm uninstall foundation-cli --global</code>.</p>
+</div>
 
 ---
 
-
 ## Download
 
 <div class="row">