diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..63b0f8a --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# ugi + +Universal Geek Identifier. Spec, CLI, and web tool. + +## Contents + +- `spec/`: UGI specification, registry JSON, grammar files, generation scripts +- `cli/`: `ugi` shell script for encoding and decoding from the command line +- `web/`: web tool generated from the registry; run `gen_tool.py` to rebuild +- `fonts/`: Kawkab Mono typeface used by the web tool + +## Build web tool + +```sh +python3 web/scripts/gen_tool.py spec/ugi_registry_v0.json web/index.html +``` + +## Links + +- Live tool: <https://ugi.gumx.cc> +- Spec: `spec/README.md` +- CLI: `cli/README.md` |