Command line interface for CodeRoad.

> npm install -g coderoad-cli

• 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 another empty directory to test your tutorial. Run > npm link coderoad-$NAME$ & > npm install. This will install your development tutorial package link as a node module.
• Open atom-coderoad to view the tutorial. Your package should appear as a loaded package.

• create [name]
• build [tutorial.md]
• publish [version] currently instructions only
• tutorials coming soon
• search [query] currently instructions only
• docs
• help

"create" gets you started building your tutorial.

> coderoad create $my-tutorial-name$

"create" generates:

• a package.json configuration with the following settings:

  "name": "coderoad-$TUTORIAL-NAME$",
  "main": "coderoad.json",
  "keywords": ["coderoad", "tutorial"],
  "coderoad": {
      "testDir": "test",
      "testSuffix": ".spec.js"
    }

• an example tutorial.md file & tutorial directory
• an example test directory with a few example tests

Feel free to fill out the "author" or "authors" field, and add any additional project related keywords.

"build" compiles your markdown tutorial into a data file called coderoad.json.

"build" defaults to tutorial/tutorial.md. Optionally specify the path to your tutorial markdown file.

> 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.