diff options
| author | Craig Jennings <c@cjennings.net> | 2026-06-24 06:31:19 -0400 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-06-24 06:31:19 -0400 |
| commit | 0e3c26d98900457e341751af9a492725e81655ef (patch) | |
| tree | 0a12ff656ae41513b382378cfa55304274abc40c | |
| parent | a34392ffbc3217957cdd72631ec417efa70f3a24 (diff) | |
| download | dotemacs-0e3c26d98900457e341751af9a492725e81655ef.tar.gz dotemacs-0e3c26d98900457e341751af9a492725e81655ef.zip | |
docs: holistic README pass — version floor, layout, features, targets
Bump the Emacs floor to 30 (developed on 30.2). Fix the module count (~100 to ~120), add docs/ to the layout, and reword scripts/ now that it also holds theme-studio. Add Theme Studio, the ghostel native terminal, and ai-term to Features, and make coverage-summary to the dev targets.
Claude-Session: https://claude.ai/code/session_01BqrdWUo9GcznYX2pZr76gZ
| -rw-r--r-- | README.org | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/README.org b/README.org index ca3c3b14f..235050469 100644 --- a/README.org +++ b/README.org @@ -16,7 +16,8 @@ my habits. Feel free to read, borrow, or steal; no support promised. * Requirements -- Emacs 29 or newer (uses ~lexical-binding~, ~use-package~, native comp) +- Emacs 30 or newer (developed on 30.2; uses ~lexical-binding~, + ~use-package~, native comp) - Linux / macOS / FreeBSD / Windows — the config checks host via =host-environment.el= and degrades where platform features are missing - Several modules shell out to external tools (e.g. =ffmpeg=, @@ -29,13 +30,14 @@ my habits. Feel free to read, borrow, or steal; no support promised. . ├── early-init.el startup perf, package system, local repos ├── init.el module loader (one require per feature) -├── modules/ feature modules — one domain per file (~100 files) +├── modules/ feature modules — one domain per file (~120 files) ├── tests/ ERT tests — test-<module>*.el, testutil-*.el ├── assets/ data files checked into git ├── custom/ user customizations and overrides ├── snippets/ yasnippet templates ├── themes/ local themes -├── scripts/ helper shell scripts (elpa mirror, setup, etc.) +├── scripts/ helper scripts + theme-studio (the theming tool) +├── docs/ specs and design documentation ├── org-roam-templates/ capture templates for org-roam ├── githooks/ optional git hooks (pre-commit, etc.) └── Makefile test / lint / validate / profile targets @@ -61,6 +63,15 @@ my habits. Feel free to read, borrow, or steal; no support promised. project directories, surfaces dirty/unpushed repos for review. - *Mu4e + org-msg + org-contacts* — integrated mail workflow. - *Reveal.js and ox-hugo* — slide decks and blog publishing from org. +- *Theme Studio* (=scripts/theme-studio/=) — an in-house, browser-based + theme builder: edit faces across packages with live previews, contrast + readouts, and export to a loadable theme. Carries its own test pyramid + (=run-tests.sh=: Python + Node + headless-browser gates). +- *Native terminal* (=modules/term-config.el=) — ghostel (over + libghostty-vt) with an F12 toggle and a tmux-aware copy-mode; replaced + vterm. +- *AI agent terminals* (=modules/ai-term.el=) — launch and switch between + per-project Claude/agent sessions in ghostel under =C-; a=. - *Custom keymap* under =C-;= prefix for personal commands. * Development @@ -73,6 +84,7 @@ make test # Run all ERT tests make test-file FILE=test-foo.el # One test file make test-name TEST=pattern # Match by test name make coverage # Generate .coverage/simplecov.json +make coverage-summary # Per-file + project coverage table (the watched number) make validate-parens # Check for unbalanced parens in modules make validate-modules # Load all modules to verify they compile make compile # Byte-compile modules |