Skip to content

Commit 106f08e

Browse files
committed
add launch/requirements/install docs
1 parent 131ebf6 commit 106f08e

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

‎README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,34 @@
1-
# coderoad-vscode README
1+
# CodeRoad VSCode
22

3-
## Features
3+
CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.
44

5-
CodeRoad allows you to play interactive coding tutorials in your editor.
5+
## Getting Started
66

7-
## Requirements
7+
### Launch
88

9-
Requires:
9+
To start the extension, inside VSCode:
10+
11+
- Open the VSCode command palette.
12+
- select “View” > “Command Palette” from the top panel
13+
- alternatively, press `cmd/ctrl + shift + P`
14+
- Search for and run `CodeRoad:Start`
15+
- A web view should appear on the right side of your editor asking you to click "Start"
16+
17+
### Requirements
1018

1119
- VSCode 1.40+
20+
[Download Visual Studio Code - Mac, Linux, Windows](https://code.visualstudio.com/download)
21+
- VSCode command line tools.
22+
For Mac, installation requires an additioanl step. See [Running Visual Studio Code on macOS](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line).
1223
- Git
1324
- Node 10+
1425

15-
## Run
26+
### Installation
27+
28+
> Currently CodeRoad is not yet available in the VSCode marketplace (coming soon!).
29+
30+
To install the extension manually:
1631

17-
1. Open the command prompt: `cmd/ctrl + shift + p`
18-
2. Search for and run `coderoad:start`
32+
- run `vsce package` to build the package.
33+
Learn more about [VSCE](https://code.visualstudio.com/api/working-with-extensions/publishing-extension)
34+
- run `code —install-extension coderoad-0.1.0.vsix`.

0 commit comments

Comments
 (0)