File tree Expand file tree Collapse file tree 1 file changed +16
-0
lines changed
Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Original file line number Diff line number Diff line change @@ -16,6 +16,22 @@ programming code, but it is nevertheless a formally defined specification for
1616writing procedures and clear rules for executing them and recording their
1717outcomes.
1818
19+ ## Usage
20+
21+ The _ technique_ program has three subcommands:
22+
23+ - _ check_ \
24+ Validate the syntax, structure, and types in a Technique document.
25+
26+ - _ format_ \
27+ Format the code in the given Technique document, embellished with ANSI
28+ syntax highlighting if run in a terminal.
29+
30+ - _ render_ \
31+ Render the Technique document into a printable PDF. This use the Typst
32+ typestting language and so requires the _ typst_ compiler be installed and on
33+ ` PATH ` .
34+
1935## Contents
2036
2137This repository contains the _ technique_ binary, which is the compiler for
You can’t perform that action at this time.
0 commit comments