Skip to content

Commit d89f7b0

Browse files
committed
improved docs
1 parent 32dd81c commit d89f7b0

File tree

3 files changed

+45
-1
lines changed

3 files changed

+45
-1
lines changed

_includes/example.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- About Section -->
2-
<section id="about" class="about container content-section text-center">
2+
<section id="video" class="container content-section text-center">
33

44
<div class="row content-section-a">
55
<div class="col-lg-10 col-lg-offset-1">

_posts/2016-01-01-installation.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,25 @@ Use [Atom CodeRoad](https://github.com/coderoad/atom-coderoad) to view and play
2121

2222
* Open *Atom-CodeRoad* in *Atom* using the "packages" menu or press *ctrl-alt-1*.
2323

24+
* It's recommended you also enable Autosave in Atom.
25+
26+
To enable autosave in Atom, go to *Atom* > *Preferences* > *Packages* > search for *"autosave"* > *settings* > check *"enabled"*.
27+
28+
* If CodeRoad is unavailable under *Atom* > *Packages* > *CodeRoad*, restart or reload atom.
29+
30+
You can use the Atom [command-palette](https://atom.io/docs/latest/getting-started-atom-basics#command-palette) to find "reload" or simply use the reload hot-key.
31+
32+
* Windows & Linux: alt-ctrl-r
33+
* Mac: ctrl-alt-cmd-l
34+
35+
### Tutorial
36+
37+
To install a tutorial, setup a *package.json* file and save the tutorial as a dependency. Make sure [NodeJS](nodejs.org) is already installed.
38+
39+
You can setup a project quickly by typing `npm init --y` into the command line in your project's folder. This agrees to all of the defaults for your newly created *package.json* file.
40+
41+
Now you can install a tutorial. Run `npm install --save-dev $THE-PACKAGE-NAME$` to save the tutorial as a package development dependency. If you run *Atom-CodeRoad* you should see the tutorial appear on the first screen.
42+
2443

2544
### CodeRoad-CLI
2645

_posts/2016-01-11-roadmap.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: docs
3+
title: Test Runners
4+
id: test-runners
5+
file: 2016-01-10-test-runner.md
6+
---
7+
CodeRoad will become more flexible & powerful with time.
8+
9+
##### v1.0.0
10+
* Lint for input errors before running (ESLint)
11+
* Final Loader solution
12+
* Improved animations
13+
* Test Tools Snippets to generate common unit test configurations
14+
* More test runners to support different programming languages (currently only Mocha test runner for JS)
15+
* @continue for page completion actions
16+
* cursor position option
17+
18+
##### v2.0.0
19+
* `@use` API for page feature choices
20+
* Optional page templates
21+
* User accounts
22+
* Record progress to db
23+
* Tutorial ratings
24+
* Testing tool for viewing your development tutorial in real-time
25+
* Suggestions?

0 commit comments

Comments
 (0)