Commitc66f60d

authored

Merge pull requestcoderoad#194 from ShMcK/docs

Docs

2 parents628f141 +cb4e1bd commitc66f60dCopy full SHA for c66f60d

File tree

-10

lines changed

-10

lines changed

Lines changed: 9 additions & 10 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`		`-#coderoad-vscode README`
	`1`	`+#CodeRoad VSCode`
`2`	`2`
`3`		`-##Features`
	`3`	`+CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.`
`4`	`4`
`5`		`-CodeRoadallows you to play interactive coding tutorials in your editor.`
	`5`	`+![CodeRoadImage](./docs/images/tutorial-example.png)`
`6`	`6`
`7`	`7`	`##Getting Started`
`8`	`8`
`@@ -19,13 +19,12 @@ To start the extension, inside VSCode:`
`19`	`19`	`###Requirements`
`20`	`20`
`21`	`21`	`- 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/)`
`22`	`27`	`- 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`
`29`	`28`
`30`	`29`	`###Installation`
`31`	`30`
`@@ -37,7 +36,7 @@ To install the extension manually:`
`37`	`36`	`Learn more about[VSCE](https://code.visualstudio.com/api/working-with-extensions/publishing-extension)`
`38`	`37`	- run`code —install-extension coderoad-0.1.0.vsix`.
`39`	`38`
`40`		`-##Creatinga Tutorial`
	`39`	`+##CreatingTutorials`
`41`	`40`
`42`	`41`	`Build and share your own interactive tutorials.`
`43`	`42`

668 KB

Comments

(0)