diff options
| author | Craig Jennings <c@cjennings.net> | 2026-04-30 07:58:24 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-04-30 07:58:24 -0500 |
| commit | 94ffab27664274f9018bc4c2ca6472ba92c50d00 (patch) | |
| tree | 21d3e8a1470b701840e0a819543c4c5562301454 /docs | |
| parent | b0d722d1a985326fb38e4e7fea237b9c4a2adcfd (diff) | |
| download | gloss-94ffab27664274f9018bc4c2ca6472ba92c50d00.tar.gz gloss-94ffab27664274f9018bc4c2ca6472ba92c50d00.zip | |
docs: expand README with usage examples
Replaces the placeholder with full usage docs modelled on chime's
README but tighter — gloss is a smaller package, the doc shouldn't
out-bulk it.
Sections: nav links, status, why-not-quick-sdcv, features, installation
(package-vc-install / use-package :vc / straight / manual), quick start
(lookup and add flows), the C-h g keybinding table plus the
gloss-add-mode binding table, the four defcustoms with rationale,
extending the source registry for v2+, org-drill integration,
troubleshooting (libxml absent, network failures, file corruption,
cache out of sync, side-window dismiss), development (Cask + ert-runner
+ Make targets), license.
The keybinding table is the source of truth — every entry matches what
`gloss-prefix-map' actually binds. The defcustoms section names the
four actual customs only (gloss-file, gloss-fetch-sources,
gloss-fetch-timeout, gloss-debug); no aspirational knobs.
Diffstat (limited to 'docs')
0 files changed, 0 insertions, 0 deletions
