parent:
25d85a34ec701b64fde8050571d39eaa9b8d1bbb
nmyk <nick@nmyk.io>
2026-11-14T23:56:34-05:00
simplify readme
diff --git a/README.md b/README.md index b918401795caec8b7c77141fbcff9aa3ec7650cd..24b8180b0bb7524954acf69124ccbda1061a0eb9 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,15 @@ length of the chain. ## Terms -| Term | Meaning | -| ------------ | ------------------------------------------------------------------------------------------------------------- | -| GovLisp | The Lisp source language. Source files use the extension `.gov.lisp`. | -| Compile | Turn GovLisp source into a `.gov` file. | -| Ratify | Validate a `.gov` file as a certification path. A program that ratifies is "lawful". | -| Trust anchor | The one self-signed certificate at the top of the chain. | -| Depth | A certificate's position below the trust anchor. The anchor is depth 0. | -| Node | One expression of the program, stored as one policy OID. | -| Copy | A node the validator creates to carry an atom down to the bottom of the tree. The interpreter ignores copies. | -| Repeal | Revoke a program with a certificate revocation list (CRL). | +| Term | Meaning | +| ------------ | ----------------------------------------------------------------------- | +| GovLisp | The Lisp source language. Source files use the extension `.gov.lisp`. | +| Compile | Turn GovLisp source into a `.gov` file. | +| Ratify | Validate a `.gov` file as a certification path. | +| Trust anchor | The one self-signed certificate at the top of the chain. | +| Depth | A certificate's position below the trust anchor. The anchor is depth 0. | +| Node | One expression of the program, stored as one policy OID. | +| Repeal | Revoke a program with a certificate revocation list (CRL). | ## Install @@ -297,16 +296,16 @@ cannot be combined with `--source`. ## Commands -| Command | Does | -| ---------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `government prog.gov` | Ratify, decode and run the program. `government run prog.gov` is the long form. | -| `government verify prog.gov` | Ratify and decode the program without running it, and print its certificate of ratification. | -| `government tree prog.gov` | Print the policy tree, with notes. | -| `government decompile prog.gov` | Print the GovLisp source, with notes as comments. | -| `government compile prog.gov.lisp -o prog.gov` | Compile a program. | -| `government repeal prog.gov -o repeal.crl` | Write a CRL that repeals a program. | -| `govlisp` | Start the REPL. | -| `govlisp prog.gov.lisp` | Run GovLisp source, with no certificates. | +| 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. | Every command that reads a `.gov` file also takes `--at`, `--anchor`, `--crl` and `--max-nodes`. Long flags take two dashes. Run `government <command> --help`