@@ -6,15 +6,23 @@ CodeRoad is a VSCode extension that allows you to play interactive coding tutori
66
77## Getting Started
88
9- ### Launch
9+ ### Start
1010
1111To start the extension, inside VSCode:
1212
13- - Open the VSCode command palette.
13+ - Open an empty VSCode workspace (an empty folder)
14+ - Launch the app from the VSCode command palette:
1415 - select “View” > “Command Palette” from the top panel
1516 - alternatively, press ` cmd/ctrl + shift + P `
16- - Search for and run ` CodeRoad:Start `
17- - A web view should appear on the right side of your editor. Click "Start"
17+ - In the command palette, search for and run ` CodeRoad:Start `
18+ - A webview should appear on the right side of your editor. Click "Start"
19+
20+ ### Install
21+
22+ Install CodeRoad from [ this link in the VSCode Marketplace] ( https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad ) .
23+
24+ - You may need to reload the window (` ctrl/cmd + R ` )
25+ - See [ "Start"] ( #start ) to get started.
1826
1927### Requirements
2028
@@ -25,24 +33,16 @@ To start the extension, inside VSCode:
2533- Node.js 10+
2634- Git
2735
28- ### Installation
29-
30- > Currently CodeRoad is not yet available in the VSCode marketplace (coming soon!).
31-
32- To install the extension manually:
33-
34- - run ` vsce package ` to build the package.
35- Learn more about [ VSCE] ( https://code.visualstudio.com/api/working-with-extensions/publishing-extension )
36- - run ` code —-install-extension coderoad-$VERSION.vsix ` where version is the name of the file.
37- - Reload the window (` ctrl/cmd + R ` )
38- - You should be able to see the extension from the extensions list on the left hand side. Verify that "CodeRoad" is "enabled".
39-
4036## Creating Tutorials
4137
4238Build and share your own interactive tutorials.
4339
4440Learn more about [ how tutorials area created] ( ./docs/tutorials.md ) .
4541
42+ ## Editing Tutorials
43+
44+ Tutorials can be edited directly as markdown on Github.
45+
4646## Contributing
4747
4848See [ CONTRIBUTING.md] ( ./CONTRIBUTING.md ) .
0 commit comments