Skip to content

Commit 1ec486e

Browse files
committed
Document subcommands
1 parent c9f2213 commit 1ec486e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,22 @@ programming code, but it is nevertheless a formally defined specification for
1616
writing procedures and clear rules for executing them and recording their
1717
outcomes.
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

2137
This repository contains the _technique_ binary, which is the compiler for

0 commit comments

Comments
 (0)