parent:
18f7f5ebceecb0e295c3daf959d352ed8b8b9694
nmyk <nick@nmyk.io>
2026-11-15T14:39:51-05:00
shuffle readme
diff --git a/README.md b/README.md index 930cdfb9cd09bff43ada700f4c3bac598f8162c7..8beb248ffb216ceaa7df19065bb106132ef8c737 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,28 @@ 5. Show the program as a policy tree: `government tree square.gov` 6. Get the source back: `government decompile square.gov` +## Commands + +| Command | Does | +| ---------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `government example.gov` | Ratify, decode and run the program. `government run example.gov` is the long form. | +| `government verify example.gov` | Ratify and decode the program without running it, and print its certificate of ratification. | +| `government tree example.gov` | Print the policy tree, with notes. | +| `government decompile example.gov` | Print the GovLisp source, with notes as comments. | +| `government compile example.gov.lisp -o example.gov` | Compile a program. | +| `government repeal example.gov -o repeal.crl` | Write a CRL that repeals a program. | +| `govlisp` | Start the REPL. | +| `govlisp example.gov.lisp` | Run GovLisp source, with no certificates. | + +### The REPL + +On a terminal, the `govlisp` REPL has line editing and history, saved in +`~/.govlisp_history`. + +- **Tab** completes a name. With nothing to complete, it indents by two spaces. +- **Ctrl-C** discards the form you are typing. +- **Ctrl-D** exits. + ## The language GovLisp is a strict Lisp with lexical scope. All values are immutable. There is @@ -286,28 +308,6 @@ ### Notes Comments in the source become notes in the certificates. `government tree` shows them, and `government decompile` turns them back into comments. - -## Commands - -| Command | Does | -| ---------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `government example.gov` | Ratify, decode and run the program. `government run example.gov` is the long form. | -| `government verify example.gov` | Ratify and decode the program without running it, and print its certificate of ratification. | -| `government tree example.gov` | Print the policy tree, with notes. | -| `government decompile example.gov` | Print the GovLisp source, with notes as comments. | -| `government compile example.gov.lisp -o example.gov` | Compile a program. | -| `government repeal example.gov -o repeal.crl` | Write a CRL that repeals a program. | -| `govlisp` | Start the REPL. | -| `govlisp example.gov.lisp` | Run GovLisp source, with no certificates. | - -### The REPL - -On a terminal, the `govlisp` REPL has line editing and history, saved in -`~/.govlisp_history`. - -- **Tab** completes a name. With nothing to complete, it indents by two spaces. -- **Ctrl-C** discards the form you are typing. -- **Ctrl-D** exits. ## Tests