Skip to content

Commit 796f1ce

Browse files
committed
update readme
1 parent 3607afb commit 796f1ce

File tree

2 files changed

+7
-29
lines changed

2 files changed

+7
-29
lines changed

README.md

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,15 @@
11
# Atom CodeRoad plugin
22

3-
Interactive coding tutorials inside of the Atom editor.
3+
Interactive coding tutorials inside of the Atom editor. [Learn more](https://coderoad.github.io).
44

55
See a [video](https://youtu.be/DbLpdgrYVOU).
66

7-
Read the [docs](https://coderoad.github.io).
7+
![Atom-CodeRoad](https://coderoad.github.io/img/gif/atom-coderoad-0.5.1.gif)
88

9-
*Currently beta. Please post issues.*
10-
11-
12-
### Atom CodeRoad
13-
14-
Use [Atom CodeRoad](https://github.com/coderoad/atom-coderoad) to view and play your tutorial.
15-
16-
You'll need to download the [Atom](https://atom.io/) editor and install *Atom Shell Commands*.
17-
18-
Install the *Atom-CodeRoad* package: `> apm install atom-coderoad`
19-
20-
For an example of how to do this, see the image below:
21-
22-
![Install atom-coderoad](https://coderoad.github.io/img/gif/install-atom-coderoad.gif)
9+
## Docs
2310

24-
You may also want to install [terminal-plus](https://atom.io/packages/terminal-plus) used in the example above.
11+
* [QuickStart](https://coderoad.github.io/docs/#install)
12+
* [Docs](https://coderoad.github.io/docs).
2513

26-
Toggle open *Atom-CodeRoad* using the *Packages* menu or press *ctrl-alt-0*.
2714

28-
29-
30-
### Tutorial
31-
32-
To install a tutorial, setup a *package.json* file and save the tutorial as a dependency. Make sure [NodeJS](nodejs.org) is already installed.
33-
34-
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.
35-
36-
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.
37-
38-
![Install a Tutorial](https://coderoad.github.io/img/gif/install-tutorial.gif)
15+
*Currently beta. Please post issues.*

src/services/start.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@ function checkSetup() {
2929
}
3030

3131
}
32+
3233
// export function installTutorial() {}

0 commit comments

Comments
 (0)