]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
docs: improve docs of CLI installation
authorNicolas Coden <nicolas@ncoden.fr>
Tue, 9 Jan 2018 21:53:42 +0000 (22:53 +0100)
committerNicolas Coden <nicolas@ncoden.fr>
Wed, 10 Jan 2018 08:28:13 +0000 (09:28 +0100)
docs/pages/installation.md

index 10cc76312b29bed5a425326041b1ebe6832e3ee3..3261afdb590de9038cdd880f9160cfd50379f192 100644 (file)
@@ -4,31 +4,33 @@ description: There are many ways to install Foundation, but if you're just getti
 video: '6KwsGcEHVTE'
 ---
 
-### Command-Line Tool
+## Install with Foundation CLI
 
-Not a fan of GUIs? The Node-powered Foundation CLI can install the same template projects for you. Install it with npm:
+Not a fan of GUIs? The Node-powered Foundation CLI can install the same template projects for you.
+
+Install Foundation CLI:
 
 ```bash
 npm install --global foundation-cli
+# or sudo npm install --global foundation-cli
 ```
 
-Depending on how your machine is configured, the command may fail with an `EACCESS` error. To get around this, run the command with `sudo` at the beginning:
+Then use to create a new Foundation project:
 
 ```bash
-sudo npm install --global foundation-cli
+foundation new
 ```
 
-<div class="callout alert">
-  <p>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>If you want to remove the old CLI, run <code>gem uninstall foundation</code>. After testing this new CLI, if you want to go back to the old CLI, run <code>npm uninstall foundation-cli --global</code>.</p>
+<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>
 
-Once you've installed the CLI, use the `new` command to start making a new project:
+<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>
 
-```bash
-foundation new
-```
 
 ---