Skip to content

Commit baca03a

Browse files
committed
update readme docs with images and summary
1 parent 106f08e commit baca03a

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

‎README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.
44

5+
![CodeRoad Image](./docs/images/tutorial-example.png)
6+
7+
Build and share your own interactive tutorials. Learn more about [how tutorials area created](./docs/tutorials.md).
8+
59
## Getting Started
610

711
### Launch
@@ -20,8 +24,9 @@ To start the extension, inside VSCode:
2024
[Download Visual Studio Code - Mac, Linux, Windows](https://code.visualstudio.com/download)
2125
- VSCode command line tools.
2226
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).
27+
- Node.js 10+
28+
[Download Node.js](https://nodejs.org/en/download/)
2329
- Git
24-
- Node 10+
2530

2631
### Installation
2732

@@ -32,3 +37,7 @@ To install the extension manually:
3237
- run `vsce package` to build the package.
3338
Learn more about [VSCE](https://code.visualstudio.com/api/working-with-extensions/publishing-extension)
3439
- run `code —install-extension coderoad-0.1.0.vsix`.
40+
41+
## License
42+
43+
[AGPL v3](https://github.com/coderoad/coderoad-vscode/blob/master/LICENSE.md)

‎docs/images/tutorial-example.png

668 KB
Loading

0 commit comments

Comments
 (0)