Skip to content

Commit 325ba8b

Browse files
committed
update docs for new build format
Signed-off-by: shmck <[email protected]>
1 parent 1b7d20b commit 325ba8b

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

README.md

+10-14
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ The configuration file is created by matching the `level` and `step` ids between
4848

4949
Tutorial description.
5050

51-
## L1 This is a level with id = 1
51+
## 1. This is a level with id = 1
5252

5353
This level has two steps...
5454

55-
### L1S1 First step
55+
### 1.1 First step
5656

5757
The first step with id L1S1. The Step id should start with the level id.
5858

@@ -62,7 +62,7 @@ The first step with id L1S1. The Step id should start with the level id.
6262
- The second hint that will show
6363
- The third and final hint, as it is last in order
6464

65-
### L1S2 The second step
65+
### 1.2 The second step
6666

6767
The second step...
6868
```
@@ -72,10 +72,10 @@ The second step...
7272
```yaml
7373
---
7474
levels:
75-
- id: L1
75+
- id: "1"
7676
config: {}
7777
steps:
78-
- id: L1S1
78+
- id: "1.1"
7979
setup:
8080
files:
8181
- package.json
@@ -86,7 +86,7 @@ levels:
8686
- package.json
8787
commands:
8888
- npm install
89-
- id: L1S2
89+
- id: "1.2"
9090
setup:
9191
files:
9292
- src/server.js
@@ -104,23 +104,19 @@ commit 8e0e3a42ae565050181fdb68298114df21467a74 (HEAD -> v2, origin/v2)
104104
Author: creator <[email protected]>
105105
Date: Sun May 3 16:16:01 2020 -0700
106106

107-
L1S1Q setup step 1 for level 1
107+
1.1 setup for level 1, step 1
108108

109109
commit 9499611fc9b311040dcabaf2d98439fc0c356cc9
110110
Author: creator <[email protected]>
111111
Date: Sun May 3 16:13:37 2020 -0700
112112

113-
L1S2A checkout solution for level 1, step 2
113+
1.1S solution for level 1, step 1
114114

115115
commit c5c62041282579b495d3589b2eb1fdda2bcd7155
116116
Author: creator <[email protected]>
117117
Date: Sun May 3 16:11:42 2020 -0700
118118

119-
L1S2Q setup level 1, step 2
119+
1.2 setup for level 1, step 2
120120
```
121121
122-
Note that the step `L1S2` has two commits, one with the suffix `Q` and another one with `A`. The suffixes mean `Question` and `Answer`, respectively, and refer to the unit tests and the commit that makes them pass.
123-
124-
Steps defined as questions are **required** as they are meant to set the task to be executed by the student. The answer is optional and should be used when a commit must be loaded to verify the student's solution.
125-
126-
If there are multiple commits for a level or step, they are captured in order.
122+
Note that the step `1.1` has two commits, one with the suffix `S`. The first commit refers to the required tests and setup, while the second optional commit contains the solution. If there are multiple commits for a level or step, they are captured in order.

0 commit comments

Comments
 (0)