diff options
Diffstat (limited to 'web/README.md')
| -rw-r--r-- | web/README.md | 39 |
1 files changed, 17 insertions, 22 deletions
diff --git a/web/README.md b/web/README.md index 50e8cef..3acccf5 100644 --- a/web/README.md +++ b/web/README.md @@ -1,46 +1,41 @@ # ugi.gumx.cc -Web-based UGI (Unified Geek Identifier) encoder, decoder, and format converter. +Web-based UGI (Unified Geek Identifier) tool: encoder, decoder, format converter, and spec reference. -## What is this? +## Pages -A self-contained HTML tool for working with UGI strings — the modernized Geek Code. It provides three functions: +- **/** — about the project and format examples +- **/specs/** — full field-by-field spec reference +- **/encoder/** — form-based interface to build a UGI string +- **/decoder/** — paste a UGI string (URI or block format) and get a human-readable breakdown +- **/converter/** — convert between URI format and block format -- **Encoder** — form-based interface to build a UGI string by selecting fields, sub-IDs, and ratings -- **Decoder** — paste a UGI string (URI or block format) and see a human-readable breakdown -- **Converter** — convert between URI format (`ugi:0@handle:...`) and block format - -The tool is a single HTML file with no external dependencies. The full UGI registry is embedded inline. - -## Usage - -Open `index.html` in any browser. No server required. - -Supports `prefers-color-scheme` for automatic dark mode. +Each page shares the same network-standard CSS and sub-navigation. ## Regenerating -The generator script takes the registry JSON path and output file path as arguments: +The generator takes the registry JSON and an output directory: ```bash -python scripts/gen_tool.py /path/to/ugi_registry_v0.json index.html +python3 scripts/gen_tool.py /path/to/ugi_registry_v0.json /output/dir/ ``` -### Requirements +This produces `index.html`, `specs/index.html`, `encoder/index.html`, `decoder/index.html`, and `converter/index.html`. -- Python 3.8+ -- No external dependencies +No external dependencies. Python 3.8+. ## Project structure ``` -ugi.gumx.cc/ -├── index.html # generated tool (deploy this) +web/ ├── scripts/ -│ └── gen_tool.py # HTML tool generator +│ └── gen_tool.py # multi-page generator +├── favicon.svg └── README.md ``` +Generated HTML files are not committed — they are produced by the post-receive hook on the server. + ## License MIT |