diff --git a/README.md b/README.md index 9753e55b..ddd38717 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,43 @@ -# coderoad-vscode README +# CodeRoad VSCode -## Features +CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor. -CodeRoad allows you to play interactive coding tutorials in your editor. +![CodeRoad Image](./docs/images/tutorial-example.png) -## Requirements +Build and share your own interactive tutorials. Learn more about [how tutorials area created](./docs/tutorials.md). -Requires: +## Getting Started + +### Launch + +To start the extension, inside VSCode: + +- Open the VSCode command palette. + - select “View” > “Command Palette” from the top panel + - alternatively, press `cmd/ctrl + shift + P` +- Search for and run `CodeRoad:Start` +- A web view should appear on the right side of your editor asking you to click "Start" + +### Requirements - VSCode 1.40+ + [Download Visual Studio Code - Mac, Linux, Windows](https://code.visualstudio.com/download) +- VSCode command line tools. + 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). +- Node.js 10+ + [Download Node.js](https://nodejs.org/en/download/) - Git -- Node 10+ -## Run +### Installation + +> Currently CodeRoad is not yet available in the VSCode marketplace (coming soon!). + +To install the extension manually: + +- run `vsce package` to build the package. + Learn more about [VSCE](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) +- run `code —install-extension coderoad-0.1.0.vsix`. + +## License -1. Open the command prompt: `cmd/ctrl + shift + p` -2. Search for and run `coderoad:start` +[AGPL v3](https://github.com/coderoad/coderoad-vscode/blob/master/LICENSE.md) diff --git a/docs/images/tutorial-example.png b/docs/images/tutorial-example.png new file mode 100644 index 00000000..cdaf6067 Binary files /dev/null and b/docs/images/tutorial-example.png differ