summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSzymon Szukalski <szymon@szymonszukalski.com>2026-04-07 10:20:08 +1000
committerSzymon Szukalski <szymon@szymonszukalski.com>2026-04-07 10:20:08 +1000
commit84cbffb03939e4f462dbfdfb98a57f3cb52461d5 (patch)
tree033264241a10e21c26fc8d6c0ea1a0565aeac73b /README.md
parent8a492e8e5b55bd6c61fd55482f7d20b2a147b3ff (diff)
Add Corfu name completion setup
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 922bcbe..4225d93 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,19 @@ The minibuffer stack is intentionally small:
- `vertico` provides the completion UI.
- `orderless` handles matching.
- `marginalia` adds annotations.
+- `corfu` handles in-buffer completion popups for text and Org buffers.
+
+Name entry uses two separate paths:
+
+- `abbrev` provides deterministic one-shot shortcuts for fixed name expansions.
+- a small CAPF feeds Corfu a fixed list of name variants from `name-dictionary.el`.
+- `M-x ss/name-dictionary-add-name` and `M-x ss/name-dictionary-remove-name` update that file and refresh the current prose buffers.
+- `M-x ss/name-dictionary-add-name-from-region` uses the active region as the name being added.
+
+### Persistent abbrevs
+
+Persistent abbrevs live in `abbrev_defs` at the repository root. The config loads that file on startup, enables abbrev mode only in text-like buffers, and saves learned abbrevs back to the same file silently when buffers are saved.
+The name shortcut list lives in `name-dictionary.el` so it can be managed from Emacs with a single source of truth.
### Babel tangle process
@@ -89,7 +102,7 @@ Daily notes are plain Org files in `~/org/daily/`, named by date. When a daily n
- `Notes`
- `Open Loops`
-This keeps daily capture fast without routing everything through Denote.
+Daily capture stays fast without routing everything through Denote.
### Agenda usage