@@ -6,15 +6,23 @@ CodeRoad is a VSCode extension that allows you to play interactive coding tutori
6
6
7
7
## Getting Started
8
8
9
- ### Launch
9
+ ### Start
10
10
11
11
To start the extension, inside VSCode:
12
12
13
- - Open the VSCode command palette.
13
+ - Open an empty VSCode workspace (an empty folder)
14
+ - Launch the app from the VSCode command palette:
14
15
- select “View” > “Command Palette” from the top panel
15
16
- 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.
18
26
19
27
### Requirements
20
28
@@ -25,24 +33,16 @@ To start the extension, inside VSCode:
25
33
- Node.js 10+
26
34
- Git
27
35
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
-
40
36
## Creating Tutorials
41
37
42
38
Build and share your own interactive tutorials.
43
39
44
40
Learn more about [ how tutorials area created] ( ./docs/tutorials.md ) .
45
41
42
+ ## Editing Tutorials
43
+
44
+ Tutorials can be edited directly as markdown on Github.
45
+
46
46
## Contributing
47
47
48
48
See [ CONTRIBUTING.md] ( ./CONTRIBUTING.md ) .
0 commit comments