update docs

ShMcK · ShMcK · commit f61dbe9f23fa · 2016-07-04T16:50:03.000-07:00
diff --git a/_posts/atom-coderoad/2016-01-01-explanation.md b/_posts/atom-coderoad/2016-01-01-explanation.md
@@ -6,4 +6,4 @@ categories:
 - atom-coderoad
 ---
 
-Coming soon...
+Atom-CodeRoad is an Atom plugin that lets you play interactive coding tutorials inside of your Atom editor. 
diff --git a/_posts/atom-coderoad/2016-01-02-installation.md b/_posts/atom-coderoad/2016-01-02-installation.md
diff --git a/_posts/atom-coderoad/2016-01-02-requirements.md b/_posts/atom-coderoad/2016-01-02-requirements.md
@@ -0,0 +1,16 @@
+---
+title: Requirements
+link: requirements
+file: 2016-01-02-requirements.md
+categories:
+- atom-coderoad
+- builder-coderoad
+---
+
+Atom-CodeRoad & Builder-CodeRoad both have several key dependencies before starting:
+
+| Name   | Min Version | Description |
+|--------|-------------|-------------|
+| NodeJS | >0.10.x     | Check your version with `> node -v`<br /> Download the latest from [nodejs.org](/nodejs.org) |
+| NPM    | >3.x.x<     | Check your version with `> npm -v`<br /> NPM comes installed with NodeJS,<br /> and can be updated with `> npm install -g npm` |
+| Atom Editor | >1.6.0 | A popular code editor available at [Atom.io](//atom.io) |
diff --git a/_posts/atom-coderoad/2016-01-03-installation.md b/_posts/atom-coderoad/2016-01-03-installation.md
@@ -0,0 +1,13 @@
+---
+title: Quick Start
+link: install
+file: 2016-01-02-installation.md
+categories:
+- atom-coderoad
+---
+
+To play a **tutorial**, you'll only need **Atom-CodeRoad**.
+
+You can install Atom packages inside of Atom through the following menus: "Atom -> Preferences -> Install", and search for "atom-coderoad".
+
+You may also choose to install *Atom Shell Commands* under the "Atom" menu. Shell commands allow you to quickly install Atom packages from the command line, for example: `> apm install atom-coderoad`.
diff --git a/_posts/atom-coderoad/2016-01-04-launch.md b/_posts/atom-coderoad/2016-01-04-launch.md
@@ -0,0 +1,9 @@
+---
+title: Launch
+link: launch
+file: 2016-01-04-launch.md
+categories:
+- atom-coderoad
+---
+
+Toggle open *Atom-CodeRoad* using the *Packages* menu or press *ctrl-alt-0*.
diff --git a/_posts/atom-coderoad/2016-01-05-install-tutorial.md b/_posts/atom-coderoad/2016-01-05-install-tutorial.md
@@ -0,0 +1,17 @@
+---
+title: Installing Tutorials
+link: install-tutorial
+file: 2016-01-05-install-tutorial.md
+categories:
+- atom-coderoad
+---
+
+To install a tutorial, setup a *package.json* file and save the tutorial as a dependency.
+
+![Install a Tutorial](/images/docs/install-tutorial.png){: .gif}
+
+You can setup a project quickly by typing `> npm init --y` into the command line in your project's folder. This agrees to all of the defaults for your newly created *package.json* file.
+
+Now you can install a tutorial. Run `> npm install --save-dev $THE-PACKAGE-NAME$` to save the tutorial as a package development dependency. If you run *Atom-CodeRoad* you should see the tutorial appear on the tutorial list screen.
+
+> If you are stuck at a screen that says 'install a tutorial', try updating your version of NPM to 3.x+.
diff --git a/_posts/atom-coderoad/2016-01-06-recommended-settings.md b/_posts/atom-coderoad/2016-01-06-recommended-settings.md
@@ -0,0 +1,15 @@
+---
+title: Recommended Settings
+link: recomended-settings
+file: 2016-01-06-recommended-settings.md
+categories:
+- atom-coderoad
+---
+
+##### Enable Autosave
+
+It's recommended you also enable *autosave* in Atom.
+
+![Enable autosave in Atom](/images/docs/autosave.png){: .gif}
+
+Tutorials run unit tests on save, *autosave* can speed up the process.
diff --git a/_posts/builder-coderoad/2016-01-02-installation.md b/_posts/builder-coderoad/2016-01-02-installation.md
diff --git a/_posts/builder-coderoad/2016-01-03-installation.md b/_posts/builder-coderoad/2016-01-03-installation.md
@@ -0,0 +1,13 @@
+---
+title: Quick Start
+link: install
+file: 2016-01-03-installation.md
+categories:
+- builder-coderoad
+---
+
+To create a **tutorial**, you'll need **Builder-CodeRoad**.
+
+You can install Atom packages inside of Atom through the following menus: "Atom -> Preferences -> Install", and search for "builder-coderoad".
+
+You may also choose to install *Atom Shell Commands* under the "Atom" menu. Shell commands allow you to quickly install Atom packages from the command line, for example: `> apm install builder-coderoad`.
diff --git a/_posts/builder-coderoad/2016-01-04-launch.md b/_posts/builder-coderoad/2016-01-04-launch.md
@@ -0,0 +1,9 @@
+---
+title: Launch
+link: launch
+file: 2016-01-04-launch.md
+categories:
+- builder-coderoad
+---
+
+Toggle open *Builder-CodeRoad* using the *Packages* menu or press *ctrl-alt-9*.
diff --git a/_posts/builder-coderoad/2016-01-05-config.md b/_posts/builder-coderoad/2016-01-05-config.md
@@ -1,7 +1,7 @@
 ---
 title: Configuration
 link: config
-file: 2016-01-03-config.md
+file: 2016-01-05-config.md
 categories:
 - builder-coderoad
 ---
diff --git a/_posts/builder-coderoad/2016-01-06-edit.md b/_posts/builder-coderoad/2016-01-06-edit.md
@@ -1,7 +1,7 @@
 ---
 title: Edit
 link: edit
-file: 2016-01-04-edit.md
+file: 2016-01-06-edit.md
 categories:
 - builder-coderoad
 ---
diff --git a/_posts/builder-coderoad/2016-01-07-test.md b/_posts/builder-coderoad/2016-01-07-test.md
@@ -1,7 +1,7 @@
 ---
 title: Unit Tests
 link: test
-file: 2016-01-05-test.md
+file: 2016-01-07-test.md
 categories:
 - builder-coderoad
 ---
diff --git a/_posts/builder-coderoad/2016-01-08-validate.md b/_posts/builder-coderoad/2016-01-08-validate.md
@@ -1,7 +1,7 @@
 ---
 title: Validate
 link: validate
-file: 2016-01-06-validate.md
+file: 2016-01-08-validate.md
 categories:
 - builder-coderoad
 ---
diff --git a/_posts/builder-coderoad/2016-01-09-publish.md b/_posts/builder-coderoad/2016-01-09-publish.md
@@ -1,7 +1,7 @@
 ---
 title: Publish
 link: publish
-file: 2016-01-07-publish.md
+file: 2016-01-09-publish.md
 categories:
 - builder-coderoad
 ---
