Skip to content

Commit 5fe3505

Browse files
committed
readme update
1 parent 90521f3 commit 5fe3505

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Use [CodeRoad CLI](https://github.com/coderoad/coderoad-cli) to setup and build
77

88
* Install *CodeRoad-CLI*. Make sure [NodeJS](nodejs.org) is already installed
99

10-
> npm install -g coderoad-cli
10+
`> npm install -g coderoad-cli`
1111

1212

1313
### Create
@@ -16,7 +16,7 @@ Get setup quickly with CodeRoad: either [clone a tutorial repo](https://git-scm.
1616

1717
In your development directory, run **create** with your new package name.
1818

19-
> coderoad create $YOUR-PACKAGE-NAME$
19+
`> coderoad create $YOUR-PACKAGE-NAME$`
2020

2121
Running **create** generates:
2222

@@ -47,13 +47,13 @@ We'll learn more about these configurations when it's time to [publish](#publish
4747

4848
Update changes to your tutorial by running **build**. This will generate a *coderoad.json* data file used by *atom-coderoad*.
4949

50-
> coderoad build
50+
`> coderoad build`
5151

5252
### Demo Your Tutorial
5353

5454
Open a new directory for demoing your tutorial. Setup a new NPM project file.
5555

56-
> npm init
56+
`> npm init`
5757

5858
Add your package name to the `dependencies` in `package.json`:
5959

@@ -73,19 +73,19 @@ Normally you would use `npm install` to install the package, but your package is
7373

7474
Inside of your tutorial root directory, run link.
7575

76-
> npm link
76+
`> npm link`
7777

7878
Inside of your demo root directory, connect the link.
7979

80-
> npm link coderoad-$YOUR-PACKAGE-NAME$
81-
> npm install
80+
`> npm link coderoad-$YOUR-PACKAGE-NAME$`
81+
`> npm install`
8282

8383

8484
### Using Atom
8585

8686
Open *Atom-Coderoad* to view your tutorial. Your package should appear as a loaded package. Click on it.
8787

88-
![CodeRoad Loaded Packages](/img/docs/loaded-packages.png)
88+
![CodeRoad Loaded Packages](https://coderoad.github.io/img/docs/loaded-packages.png)
8989

9090
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.
9191

0 commit comments

Comments
 (0)