Skip to content

Docs #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 5, 2020
Merged

Docs #193

Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
update readme docs with images and summary
  • Loading branch information
ShMcK committed Apr 5, 2020
commit baca03a75c77a2fa9f450f3d15f2fa7292ad2ade
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

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

![CodeRoad Image](./docs/images/tutorial-example.png)

Build and share your own interactive tutorials. Learn more about [how tutorials area created](./docs/tutorials.md).

## Getting Started

### Launch
Expand All @@ -20,8 +24,9 @@ To start the extension, inside VSCode:
[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+

### Installation

Expand All @@ -32,3 +37,7 @@ 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

[AGPL v3](https://github.com/coderoad/coderoad-vscode/blob/master/LICENSE.md)
Binary file added docs/images/tutorial-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.