update docs

ShMcK · ShMcK · commit 90521f35e955 · 2016-02-26T16:15:19.000-08:00
diff --git a/README.md b/README.md
@@ -1,82 +1,93 @@
 # CodeRoad CLI
-Command line interface for [CodeRoad](http://coderoad.github.io).
+Command line interface for [CodeRoad](http://coderoad.github.io). See the [docs](https://coderoad.github.io/docs) for more.
 
-## Setup
+### Install
 
-```
-> npm install -g coderoad-cli
-```
-
-## Tutorial Development
-
-##### Development
-
-* In your development directory, run `> coderoad create $NAME$`
-* Run `> npm link` to create a symbolic link to your project
-* Update changes to your tutorial by running `> coderoad build`
+Use [CodeRoad CLI](https://github.com/coderoad/coderoad-cli) to setup and build a project data file.
 
-##### Viewing/Testing your Tutorial
+* Install *CodeRoad-CLI*. Make sure [NodeJS](nodejs.org) is already installed
 
-* Open a new directory and run `> npm init`
-* Add your package name to the `dependencies` in `package.json`:
-
-```
-"dependencies": {
-    "coderoad-$NAME$": "^0.1.0"
-  }
-```
+      > npm install -g coderoad-cli
 
-* Run `> npm link coderoad-$NAME$` & `> npm install`. This will install a package link pointing at your development tutorial.
-* Open [atom-coderoad](https://github.com/coderoad/atom-coderoad) to view your tutorial. Your package should appear as a loaded package.
-* Reload Atom if necessary (cmd + shift + P, type "reload", enter)
-
-## Commands
-- create [name]
-- build [tutorial.md]
-- publish [version]   _currently instructions only_
-- tutorials           _coming soon_
-- search [query]      _currently instructions only_
-- docs
-- help
 
 ### Create
 
-"create" gets you started building your tutorial.
+Get setup quickly with CodeRoad: either [clone a tutorial repo](https://git-scm.com/docs/git-clone) or use the *CodeRoad-CLI*.
 
-```
-> coderoad create $my-tutorial-name$
-```
+In your development directory, run **create** with your new package name.
 
-"create" generates:
+    > coderoad create $YOUR-PACKAGE-NAME$
 
-* a `package.json` configuration with the following settings:
+Running **create** generates:
 
-```
+* an example `tutorial.md`, which imports several tutorial files
+* an example `test` directory with a few example tests
+* a `package.json` configuration with some of the following settings:
+
+```json
+{
   "name": "coderoad-$TUTORIAL-NAME$",
+  "version": "0.1.0",
+  "description": "Coderoad tutorial",
+  "author": "Name <email> (site)",
   "main": "coderoad.json",
   "keywords": ["coderoad", "tutorial"],
+  "dependencies": {
+      "mocha-coderoad": "^0.3.1"
+  },
   "coderoad": {
       "testDir": "test",
-      "testSuffix": ".spec.js"
-    }
+      "testSuffix": ".spec.js",
+      "testRunner": "mocha-coderoad"
+  }
+}
 ```
 
-* an example `tutorial.md` file & tutorial directory
-* an example `test` directory with a few example tests
+We'll learn more about these configurations when it's time to [publish](#publish).
 
-Feel free to fill out the "author" or "authors" field, and add any additional
-project related keywords.
+Update changes to your tutorial by running **build**. This will generate a *coderoad.json* data file used by *atom-coderoad*.
 
-### Build
+    > coderoad build
 
-"build" compiles your markdown tutorial into a data file called `coderoad.json`.
+### Demo Your Tutorial
 
-"build" defaults to `tutorial/tutorial.md`. Optionally specify the path to your tutorial markdown file.
+Open a new directory for demoing your tutorial. Setup a new NPM project file.
 
+    > npm init
+
+Add your package name to the `dependencies` in `package.json`:
+
+```json
+{
+  "dependencies": {
+      "coderoad-$YOUR-PACKAGE-NAME$": "^0.1.0"
+  }
+}
 ```
-> coderoad build
-> coderoad build $path/to/tutorial.md$
-```
 
-"build" also generates a `README.md` with an outline of your chapters & pages
-as well as an explanation of how to setup your tutorial.
+Normally you would use `npm install` to install the package, but your package isn't ready to be published yet. Instead, you need to link your tutorial package to your demo directory.
+
+### Link Your Demo & Tutorial
+
+[NPM link](https://docs.npmjs.com/cli/link) creates a symbolic link between directories. This allows your demo directory to always load your tutorial package.
+
+Inside of your tutorial root directory, run link.
+
+    > npm link
+
+Inside of your demo root directory, connect the link.
+
+    > npm link coderoad-$YOUR-PACKAGE-NAME$
+    > npm install
+
+
+### Using Atom
+
+Open *Atom-Coderoad* to view your tutorial. Your package should appear as a loaded package. Click on it.
+
+![CodeRoad Loaded Packages](/img/docs/loaded-packages.png)
+
+Reload *Atom* to view changes. You can use the Atom [command-palette](https://atom.io/docs/latest/getting-started-atom-basics#command-palette) to find "reload" or simply use the reload hot-key.
+
+* Windows & Linux: alt-ctrl-r
+* Mac: ctrl-alt-cmd-l
diff --git a/src/build/parser/actions.js b/src/build/parser/actions.js
@@ -17,7 +17,7 @@ function doAction(type, isArray, actionValue, result, line, index) {
     if (!!isArray) {
         var valueList = actionValue.slice(1, -1).split(',');
         valueList.forEach(function (value) {
-            var value = cleanup_1.trimQuotes(value.trim(), true);
+            value = cleanup_1.trimQuotes(value.trim(), true);
             result.chapters[index.chapter].pages[index.page].tasks[index.task][type].push(value);
         });
     }

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ function doAction(type, isArray, actionValue, result, line, index) {`
`17`	`17`	`if (!!isArray) {`
`18`	`18`	`var valueList = actionValue.slice(1, -1).split(',');`
`19`	`19`	`valueList.forEach(function (value) {`
`20`		`- var value = cleanup_1.trimQuotes(value.trim(), true);`
	`20`	`+ value = cleanup_1.trimQuotes(value.trim(), true);`
`21`	`21`	`result.chapters[index.chapter].pages[index.page].tasks[index.task][type].push(value);`
`22`	`22`	`});`
`23`	`23`	`}`