pupate

README.md

 1# ACHTUNG!
 2Any changes you make to the files in this repo will be overwritten by a build process!
 3
 4This module was generated from source by the pupate program.
 5{{- with (getenv "CI_PROJECT_URL")}}
 6The source that generated this is located at
 7{{.}}
 8{{- else}}
 9Pupate was run against the source directory for the output you are looking at.
10{{- end}}
11You should edit the source, and not this :)
12
13
14# Where To Edit The Source
15
16Where to make changes depends on what you are trying to change:
17
18## training.json
19
20Everything under the `modules` key originates from source puzzle directories.
21Edit `*/puzzle.md` in the source repository.
22
23The authors list is built from source puzzle authors.
24Edit `*/puzzle.md` in the source repository.
25
26Everything else (prerequisites, course description, and more) is read from the source category.
27Edit `category.md` in the source repository.
28
29
30## */puzzle.md
31
32These correspond to `*/puzzle.md` in the source directory,
33but SCTR rewrites directory names,
34so you may need to dig around a little to find the right source puzzle.
35
36Hopefully your source repository uses descriptive puzzle directory names,
37and it will be obvious where to go.
38If not, the front matter in the SCTR `puzzle.md` file will have a
39`pupate.source` value that tells where to look in the source repository.