aboutsummaryrefslogtreecommitdiffstats
path: root/web/README.md
blob: 31c1c28f661a80e754cec244c4690465d4613100 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# ugi.gumx.cc

Web-based UGI (Unified Geek Identifier) tool: encoder, decoder, format converter, and spec reference.

## Pages

- **/** : 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

Each page shares the same network-standard CSS and sub-navigation.

## Regenerating

The generator takes the registry JSON and an output directory:

```bash
python3 scripts/gen_tool.py /path/to/ugi_registry_v0.json /output/dir/
```

This produces `index.html`, `specs/index.html`, `encoder/index.html`, `decoder/index.html`, and `converter/index.html`.

No external dependencies. Python 3.8+.

## Project structure

```
web/
├── scripts/
│   └── 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