Skip to content

Commit 366ad02

Browse files
committed
setup instructions
1 parent 14c4155 commit 366ad02

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,19 @@ Command line interface for [CodeRoad](http://coderoad.github.io).
1515
* Run `> npm link` to create a symbolic link to your project
1616
* Update changes to your tutorial by running `> coderoad build`
1717

18-
##### Trying your Tutorial
18+
##### Viewing/Testing your Tutorial
1919

20-
* 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.
21-
* Open `atom-coderoad` to view the tutorial. Your package should appear as a loaded package.
20+
* Open a new directory and run `> npm init`
21+
* Add your package name to the `dependencies` in `package.json`:
22+
23+
```
24+
"dependencies": {
25+
"coderoad-$NAME$": "^0.1.0"
26+
}
27+
```
28+
29+
* Run `> npm link coderoad-$NAME$` & `> npm install`. This will install a package link pointing at your development tutorial.
30+
* Open [atom-coderoad](https://github.com/coderoad/atom-coderoad) to view your tutorial. Your package should appear as a loaded package.
2231

2332

2433
## Commands

0 commit comments

Comments
 (0)