|
1 | 1 | # CodeRoad Atom plugin |
2 | 2 |
|
3 | | -Interactive coding tutorials inside of the Atom editor. |
| 3 | +Interactive coding tutorials inside of the Atom editor. Learn more at [coderoad.io](https://coderoad.github.io). |
4 | 4 |
|
5 | | -** Currently early alpha. Expect issues & changes. ** |
| 5 | +** Currently beta. Post issues. ** |
6 | 6 |
|
7 | 7 |
|
8 | | -## Setup |
| 8 | +### Setup Atom CodeRoad |
9 | 9 |
|
10 | | -##### Install Atom Package |
| 10 | +Use [Atom CodeRoad](https://github.com/coderoad/atom-coderoad) to view and play your tutorial |
11 | 11 |
|
12 | | - apm install atom-coderoad |
| 12 | +* Download the [Atom](https://atom.io/) editor |
13 | 13 |
|
14 | | -##### Enable Autosave |
| 14 | +* Install the *Atom-CodeRoad* package, or use the [apm](https://github.com/atom/apm) command-line tool |
15 | 15 |
|
16 | | -To enable autosave in Atom, go to Atom > Preferences > Packages > search for "autosave" > settings > check "enabled". |
| 16 | + > apm install atom-coderoad |
17 | 17 |
|
| 18 | +* Open *Atom-CodeRoad* in *Atom* using the "packages" menu or press *ctrl-alt-1*. |
18 | 19 |
|
19 | | -## Roadmap |
| 20 | +* It's recommended you also enable Autosave in Atom. |
20 | 21 |
|
21 | | -##### v1.0.0 |
22 | | -* Extended demo |
23 | | -* `@hints` API |
24 | | -* Docs |
25 | | -* Autorun test setting |
26 | | -* Improved test failure display |
27 | | -* Lint for input errors before running (ESLint) |
28 | | -* Loaders for different file types (TypeScript, CoffeeScript, etc.) |
29 | | -* `@use` API for page feature choices |
30 | | -* Improved animations |
31 | | -* Test Tools to generate common unit test configurations |
32 | | -* More test runners to support different programming languages (currently only Mocha test runner for JS) |
| 22 | +To enable autosave in Atom, go to *Atom* > *Preferences* > *Packages* > search for *"autosave"* > *settings* > check *"enabled"*. |
33 | 23 |
|
34 | | -##### v2.0.0 |
35 | | -* Optional page templates |
36 | | -* User accounts |
37 | | -* Record progress to db |
38 | | -* Tutorial ratings |
39 | | -* Suggestions? |
| 24 | +* If CodeRoad is unavailable under *Atom* > *Packages* > *CodeRoad*, restart or reload atom. |
| 25 | + |
| 26 | +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. |
| 27 | + |
| 28 | +* Windows & Linux: alt-ctrl-r |
| 29 | +* Mac: ctrl-alt-cmd-l |
| 30 | + |
| 31 | +### Install a Tutorial |
| 32 | + |
| 33 | +To install a tutorial, setup a *package.json* file and save the tutorial as a dependency. Make sure [NodeJS](nodejs.org) is already installed. |
| 34 | + |
| 35 | +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. |
| 36 | + |
| 37 | +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 first screen. |
0 commit comments