Skip to content

Commit 14c4155

Browse files
committed
basic development instructions
1 parent 49919f2 commit 14c4155

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ Command line interface for [CodeRoad](http://coderoad.github.io).
77
> npm install -g coderoad-cli
88
```
99

10+
## Tutorial Development
11+
12+
##### Development
13+
14+
* In your development directory, run `> coderoad create $NAME$`
15+
* Run `> npm link` to create a symbolic link to your project
16+
* Update changes to your tutorial by running `> coderoad build`
17+
18+
##### Trying your Tutorial
19+
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.
22+
23+
1024
## Commands
1125
- create [name]
1226
- build [tutorial.md]

0 commit comments

Comments
 (0)