Skip to content

Commit db97ace

Browse files
committed
content edits
1 parent 027a3de commit db97ace

File tree

4 files changed

+10
-8
lines changed

4 files changed

+10
-8
lines changed

_posts/landing/2016-02-01-atom-coderoad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ categories:
1414
---
1515

1616
CodeRoad is a free plugin for the popular [Atom Editor]("https://atom.io").
17-
With the "atom-coderoad" plugin, code in a real editor environment alongside your other favorite plugins.
17+
With the "atom-coderoad" plugin, take tutorials in a real editor environment alongside your other favorite plugins.

_posts/overview/2016-01-01-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ categories:
77

88
> CodeRoad aims to make building & sharing interactive coding tutorials as easy as possible.
99
10-
We hope to create fun and maintainable code tutorials that actually improve with time. We hope to see programming students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive coding tutorials built. That's where you come in.
10+
We hope to create fun and maintainable code tutorials that improve with time. We hope to see programming students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive coding tutorials built. That's where you come in.

_posts/tutorial-docs/2016-01-01-demo-tutorial.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ Add your package name to the `dependencies` in `package.json`:
2222
}
2323
```
2424

25-
Normally you would use `> npm install` to install the package, but your package isn't ready to be published yet. Instead, you need to link your tutorial package to your demo directory.
25+
Normally you would use `> npm install` to install the package, but your package isn't ready to be published yet. Instead, you need to *"link"* your tutorial package to your demo directory.
2626

2727
### Link Your Demo & Tutorial
2828

2929
[NPM link](https://docs.npmjs.com/cli/link) creates a symbolic link between directories. This allows your demo directory to always load your tutorial package.
3030

31-
Inside of your tutorial root directory, run link.
31+
Inside of your tutorial root directory, run npm link.
3232

3333
> npm link
3434

@@ -40,6 +40,8 @@ Inside of your demo root directory, connect the link.
4040

4141
### Using Atom
4242

43-
Open *Atom-Coderoad* to view your tutorial. Your package should appear as a loaded package. Click on it.
43+
Use [*Builder-CodeRoad*](/builder-coderoad.html) to develop your tutorial. Builder-CodeRoad allows you to visualize and test your tutorial as you develop it.
4444

45-
Reload *Atom* to view changes. 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 (*Windows & Linux*: alt-ctrl-r, *Mac*: ctrl-alt-cmd-l).
45+
When it's ready, you can play your tutorial in *Atom-Coderoad*. Your package should appear as a loaded package. Click on it.
46+
47+
If you make any changes to your tutorial, you'll have to reload *Atom* to view them. 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 (*Windows & Linux*: alt-ctrl-r, *Mac*: ctrl-alt-cmd-l).

_posts/tutorial-docs/2016-01-02-coderoad-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ categories:
88

99
Of course Markdown couldn't cover all uses necessary for CodeRoad. Instead, there is a special **CodeRoad API** which is parsed into the data file whenever you run `> coderoad build`.
1010

11-
For these API features to work, they must be placed at the beginning of a line.
11+
For these API features to work, they must be placed at the *beginning of a line*.
1212

1313
```markdown
1414
@import('file') // ✓
@@ -32,7 +32,7 @@ Features can be commented out, allowing you to view different files at a time. B
3232
@import('./path/to/file.md')
3333
```
3434

35-
See an [example](https://github.com/coderoad/coderoad-functional-school/blob/master/tutorial/tutorial.md).
35+
See an [example tutorial file](https://github.com/coderoad/coderoad-functional-school/blob/master/tutorial/tutorial.md).
3636

3737

3838
### `@test`

0 commit comments

Comments
 (0)