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.

Sign up for GitHub

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
106f08e
add launch/requirements/install docs
ShMcK Apr 5, 2020
baca03a
update readme docs with images and summary
ShMcK Apr 5, 2020
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
Next Next commit
add launch/requirements/install docs
  • Loading branch information
@ShMcK
ShMcK committed Apr 5, 2020
commit 106f08e2da94b81e566687d093a05c264d44217d
32 changes: 24 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,34 @@
# 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.
## Getting Started

## Requirements
### Launch

Requires:
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).
- Git
- Node 10+

## Run
### Installation

> Currently CodeRoad is not yet available in the VSCode marketplace (coming soon!).

To install the extension manually:

1. Open the command prompt: `cmd/ctrl + shift + p`
2. Search for and run `coderoad:start`
- 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`.