Skip to content

Commit 019bf96

Browse files
committed
readme update for build options
1 parent 6c4527f commit 019bf96

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,11 @@ project related keywords.
4747

4848
"build" compiles your markdown tutorial into a data file called `coderoad.json`.
4949

50-
You must specify the path to your tutorial markdown file, normally `tutorial.md`.
50+
"build" defaults to `tutorial/tutorial.md`. Optionally specify the path to your tutorial markdown file.
5151

5252
```
53-
> coderoad build $tutorial.md$
53+
> coderoad build
54+
> coderoad build $path/to/tutorial.md$
5455
```
5556

5657
"build" also generates a `README.md` with an outline of your chapters & pages

0 commit comments

Comments
 (0)