init

Author: ShMcK

TUTORIAL.md

@@ -0,0 +1,34 @@
+# Insert Tutorial's Title here
+
+Short description to be shown as a tutorial's subtitle
+
+## L1 Put Level's title here
+
+> Level's summary: a short description of the level's content in one line.
+
+The level is identified and distributed following the regex:
+
+```js
+/^(##\s(?<levelId>L\d+)\s(?<levelTitle>.*)\n*(>\s*(?<levelSummary>.*))?\n+(?<levelContent>[^]*))/;
+```
+
+The Level can be split into steps or have no steps. Levels without steps are meant to be used as only informative content, for example: use a Level without steps at the end of the tutorial to congratulate the student and provide some additional related resources.
+
+Tutorial's content. It can span through multiple paragraphs and use headers `####` and `#####`.
+
+Steps are identified and their content described using the following regex:
+
+```js
+/^(###\s(?<stepId>(?<levelId>L\d+)S\d+)\s(?<stepTitle>.*)\n+(?<stepContent>[^]*))/;
+```
+
+The numbers identifying the levels and steps are irrelevant but keep in mind that they will be executed in order. A level with id `10` will be executed before another one with id `20` and so on. These `ids` should have a match in the configuration file (`coderoad.yaml`).
+
+### L1S1 A step title (not being shown on the extension at this moment)
+
+Short description of the step's purpose. Should be short and fit in one line
+
+**Important**
+
+1. Both level and step ids must have an entry with the same id on the configuration file;
+2. Step Ids are based on its level id. Any step from level `L234` must start with `L234S`, followed by the sequential digits.

coderoad.yaml

@@ -0,0 +1,62 @@
+# A configuration file for a CodeRoad Tutorial
+# This is a YAML-formatted file.
+## Your personal version of the tutorial
+##
+version: "0.1.0"
+## Data used to configure and setup the tutorial
+##
+config:
+## Test runner setup.
+testRunner:
+## The command called to run the test runner. For example "npm run test", or a path to the test runner binary. Required.
+command: python
+## Standard arguments used by a given test runner
+args:
+## The command arg used to convert test runner output to TAP format. See https://testanything.org/ for more. Required.
+tap: -m tap.py
+## The directory where to run the test runner from. If not specified, tests will run from the root of the project. Optional.
+directory: tests
+## Commits to load to setup the test runner. Optional.
+##
+setup:
+# - commit1
+# - commit2
+## A list of commands to run to configure the tutorial
+commands:
+[]
+# - npm install
+## App versions helps to ensure compatability with the Extension
+appVersions:
+## Ensure compatability with a minimal VSCode CodeRoad version
+vscode: ">=0.7.2"
+## Repo information to load code from
+##
+repo:
+## The uri path to the repo containing the code commits. Required.
+##
+uri: ""
+## The branch on the repo uri that contains the code commits. Required.
+branch: ""
+
+## A list of tutorial dependencies to ensure the environment is setup for the tutorial. Optional.
+## The dependencies will be checked by running `dependency.name` --version and comparing it to the version provided.
+##
+dependencies:
+[]
+## The name of the dependency
+# - name: node
+# ## The version requirement. See https://github.com/npm/node-semver for options.
+# version: '>=10'
+
+## A level is made up of
+levels:
+ - id: L1
+steps:
+## Example 1: Opening files
+ - id: L1S1
+## Setup for the first task. Required.
+setup:
+## Solution for the first task. Required.
+solution:
+
+