Skip to content

Commit e239065

Browse files
committed
Describe examples
1 parent 4373d96 commit e239065

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,28 @@ 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+
Documents written in Technique have file extension _\*.tq_.
20+
21+
## Examples
22+
23+
To give a sense of the flavour of the language, here are two examples.
24+
25+
First, from a set of instructions guiding staff of what to do when an incident
26+
occurs:
27+
28+
![Don't Panic](examples/screenshots/DontPanic.png)
29+
30+
Second, shows using Technique to describe a much larger procedure, in his case
31+
the entire process of doing systems engineering on a software project. This
32+
pushes the limits of what Technique is for, but nevertheless illustrates that
33+
it can be used for very large structures as well as very detailed ones:
34+
35+
![Systems Engineering Process](examples/screenshots/SystemsEngineeringProcess.png)
36+
37+
Detailed examples can be found in the _examples/_ and _tests/_ directories.
38+
39+
## Contents
40+
1941
This repository contains the _technique_ binary, which is the compiler for
2042
Technique v1, along with a code formatter, and machinery to render procedures
2143
as PDFs. Syntax highlighting is available for Vim, the Zed Editor, Sublime

examples/screenshots/DontPanic.png

260 KB
Loading
363 KB
Loading

0 commit comments

Comments
 (0)