From 71ccfdd0e6216356ec6cac90bc627fe02dbfdeb1 Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Tue, 28 Apr 2026 13:56:06 -0500 Subject: chore: scaffold gloss package Five layered files per the design at docs/design/gloss.org. gloss-core for the data layer, gloss-fetch for the network layer, gloss-display for the UI, gloss-drill for the spaced-repetition export, and gloss.el as the entry point. All five are skeletons. Implementation comes next. The Makefile delegates to ert with the usual unit, integration, and per-file targets. It also runs paren and lint passes. The package is licensed GPL-3.0-or-later. README is a placeholder pointing at the design doc. --- README.org | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.org (limited to 'README.org') diff --git a/README.org b/README.org new file mode 100644 index 0000000..659fc89 --- /dev/null +++ b/README.org @@ -0,0 +1,20 @@ +#+TITLE: gloss — Glossary Lookup with Online-Sourced Selection +#+OPTIONS: toc:nil + +A personal Emacs glossary. =C-h g= looks up terms in a single git-tracked org file. On a local miss, =gloss= fetches candidate definitions from Wiktionary and prompts you to pick which one to save — with provenance recorded. The same org file feeds =org-drill= for spaced-repetition study. + +* Status + +In active development. v1 not yet released. See [[file:docs/design/gloss.org][docs/design/gloss.org]] for the full design. + +* Why not just =quick-sdcv= or =dictionary=? + +Domain jargon — government acronyms, technical terms, philosophy vocabulary, project-specific names — doesn't live in any general dictionary, so =quick-sdcv= and =M-x dictionary= can't help. =gloss= grows by use: encounter a term, save it once, and it's permanently looked-up-able and study-card-able. + +* Quick start + +(This section will fill out as v1 lands. For now, see [[file:docs/design/gloss.org][docs/design/gloss.org]].) + +* License + +GPL-3.0-or-later. See [[file:LICENSE][LICENSE]]. -- cgit v1.2.3