Skip to content

Commit 24bfb91

Browse files
committed
Initial README for compiler
1 parent c699d00 commit 24bfb91

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Technique
2+
3+
This is the Technique Procedure Language, a programming language for
4+
describing procedures in a structured but human-readable form. You can
5+
consider it a domain-specific language (DSL) for writing procedures and
6+
checklists.
7+
8+
This language design has evolved over a long period, 20+ years, starting with
9+
on-paper procedures for systems operations tasks, and then going through
10+
different iterations of program and approach. The current version is Technique
11+
v1, written in Rust.
12+
13+
The Technique language allows you to write instructions to be read and
14+
followed other humans. As a result, Technique doesn't look much like
15+
programming code, but it is nevertheless a formally defined specification for
16+
writing procedures and clear rules for executing them and recording their
17+
outcomes.
18+
19+
This repository contains the _technique_ binary, which is the compiler for
20+
Technique v1, along with a code formatter, and machinery to render procedures
21+
as PDFs. Syntax highlighting is available for Vim, the Zed Editor, Sublime
22+
Text, and the Typst typesetter. There's a language server, and an extension
23+
for Zed, with VS Code and NeoVim on the way.

0 commit comments

Comments
 (0)