8000 Merge pull request #194 from ShMcK/docs · phptuts/coderoad-vscode@c66f60d · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit c66f60d

Browse files
authored
Merge pull request coderoad#194 from ShMcK/docs
Docs
2 parents 628f141 + cb4e1bd commit c66f60d

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
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+
![CodeRoad Image](./docs/images/tutorial-example.png)
66

77
## Getting Started
88

@@ -19,13 +19,12 @@ To start the extension, inside VSCode:
1919
### Requirements
2020

2121
- VSCode 1.40+
22+
[Download Visual Studio Code - Mac, Linux, Windows](https://code.visualstudio.com/download)
23+
- VSCode command line tools.
24+
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).
25+
- Node.js 10+
26+
[Download Node.js](https://nodejs.org/en/download/)
2227
- Git
23-
- Node 10+
24-
25-
## Run
26-
27-
1. Open the command prompt: `cmd/ctrl + shift + p`
28-
2. # Search for and run `coderoad:start`
2928

3029
### Installation
3130

@@ -37,7 +36,7 @@ To install the extension manually:
3736
Learn more about [VSCE](https://code.visualstudio.com/api/working-with-extensions/publishing-extension)
3837
- run `code —install-extension coderoad-0.1.0.vsix`.
3938

40-
## Creating a Tutorial
39+
## Creating Tutorials
4140

4241
Build and share your own interactive tutorials.
4342

docs/images/tutorial-example.png

668 KB
Loading

0 commit comments

Comments
 (0)
0