aboutsummaryrefslogtreecommitdiff
path: root/template/README.md
diff options
context:
space:
mode:
authorcrupest <crupest@outlook.com>2022-11-01 21:25:43 +0800
committercrupest <crupest@outlook.com>2022-11-01 21:25:43 +0800
commitbdf4aead4dd2a354220d120a76fc625dbb2dc83a (patch)
tree3c70f0e60095782da3630feabc160a4d0ae5feef /template/README.md
parentc35b62b0529716e802da9b8af7a9e7c1dac506b1 (diff)
downloadcrupest-bdf4aead4dd2a354220d120a76fc625dbb2dc83a.tar.gz
crupest-bdf4aead4dd2a354220d120a76fc625dbb2dc83a.tar.bz2
crupest-bdf4aead4dd2a354220d120a76fc625dbb2dc83a.zip
...
Diffstat (limited to 'template/README.md')
-rw-r--r--template/README.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/template/README.md b/template/README.md
index 698dd1d..62d00a3 100644
--- a/template/README.md
+++ b/template/README.md
@@ -1,7 +1,6 @@
-This directory contains the template files to generate the final config files.
-The template format is quite simple: they are just files containing `{{VAR}}`s. You can simply use text substitution to do the generation. All variable names begin with `CRUPEST_` to avoid name conflicts.
+This directory contains the template files used to generate the final config files. They should not be used directly usually. Run `../tool/setup.py` to perform any generation and necessary setup.
-Run `generate.py` and it will help you configure and generate the final config files.
+The template format is quite simple: they are just files containing `{{VAR}}`s. You can simply use text substitution to do the generation. All variable names begin with `CRUPEST_` to avoid name conflicts.
Here are the variables used in templates:
| Variable | Description |