From 6bb7f9b91304847d92222bf25ca6021fd82d468d Mon Sep 17 00:00:00 2001
From: Craig Jennings <c@cjennings.net>
Date: Tue, 5 May 2026 10:10:30 -0500
Subject: docs: rewrite README as a slim modernized front-door
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Replaced the 1049-line README.md (which inlined the entire user
manual) with a ~227-line README.org that's the standard 'GitHub
front page' for an Emacs package.  The deep manual lives where it
already does — in org-drill.org, which is also a runnable demo
deck.

Sections, in order:
- Title + nav links
- Five badges: made-for-emacs, MELPA, MELPA Stable, GitHub Actions
  CI, Coveralls.  CI and coverage badges are aspirational until
  the GitHub Actions TODO lands; their URLs are correct so they
  auto-populate when CI is set up.
- Maintenance status: explains the fork, lists recently-fixed
  upstream issues, points at the GitHub mirror and Issues.
- Features: bullet list of capabilities
- Installation: MELPA, package-vc-install, use-package :vc,
  Straight, manual.  Drops the stale 'tick drill in org-modules'
  + Org contrib references.
- Quick Start: 60-second flow from install to first drill
- In-Session Keys: cheat sheet table for both the question and
  rating phases (closes the existing #A TODO for the cheat sheet)
- Configuration: most-used defcustoms with comments
- Development: make-target table
- History: contrib → phillord → cjennings handoff story
- License pointer

Closes three #A TODOs: README modernization, stale install
instructions, in-session keybinding cheat sheet.

Added assets/made-for-emacs-badge.svg (copied from emacs-wttrin).
---
 assets/made-for-emacs-badge.svg | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 assets/made-for-emacs-badge.svg

(limited to 'assets')

diff --git a/assets/made-for-emacs-badge.svg b/assets/made-for-emacs-badge.svg
new file mode 100644
index 0000000..5f9df38
--- /dev/null
+++ b/assets/made-for-emacs-badge.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="151" height="20" role="img" aria-label="Made for: GNU Emacs"><title>Made for: GNU Emacs</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="151" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="76" height="20" fill="#555"/><rect x="76" width="75" height="20" fill="#7f5ab6"/><rect width="151" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><image x="5" y="3" width="14" height="14" xlink:href="data:image/svg+xml;base64,PHN2ZyBmaWxsPSIjZmFmYWZhIiByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48dGl0bGU+R05VIEVtYWNzPC90aXRsZT48cGF0aCBkPSJNMTIsMjRDNS40NDgsMjQsMC4xMTgsMTguNjE3LDAuMTE4LDEyUzUuNDQ4LDAsMTIsMGM2LjU1MiwwLDExLjg4Miw1LjM4MywxMS44ODIsMTJTMTguNTUyLDI0LDEyLDI0eiBNMTIsMC42NjEgQzUuODEzLDAuNjYxLDAuNzc5LDUuNzQ4LDAuNzc5LDEyUzUuODEzLDIzLjMzOSwxMiwyMy4zMzljNi4xODcsMCwxMS4yMjEtNS4wODYsMTEuMjIxLTExLjMzOVMxOC4xODcsMC42NjEsMTIsMC42NjF6IE04LjAzLDIwLjE5NyBjMCwwLDAuOTc4LDAuMDY5LDIuMjM2LTAuMDQyYzAuNTEtMC4wNDUsMi40NDQtMC4yMzUsMy44OTEtMC41NTJjMCwwLDEuNzY0LTAuMzc3LDIuNzA3LTAuNzI1YzAuOTg3LTAuMzY0LDEuNTI0LTAuNjczLDEuNzY2LTEuMTEgYy0wLjAxMS0wLjA5LDAuMDc0LTAuNDA4LTAuMzgxLTAuNTk5Yy0xLjE2NC0wLjQ4OC0yLjUxNC0wLjQtNS4xODUtMC40NTdjLTIuOTYyLTAuMTAyLTMuOTQ4LTAuNTk4LTQuNDcyLTAuOTk3IGMtMC41MDMtMC40MDUtMC4yNS0xLjUyNiwxLjkwNy0yLjUxM2MxLjA4Ni0wLjUyNiw1LjM0NS0xLjQ5Niw1LjM0NS0xLjQ5NmMtMS40MzQtMC43MDktNC4xMDktMS45NTUtNC42NTktMi4yMjQgYy0wLjQ4Mi0wLjIzNi0xLjI1NC0wLjU5MS0xLjQyMS0xLjAyMWMtMC4xOS0wLjQxMywwLjQ0OC0wLjc2OCwwLjgwNC0wLjg3YzEuMTQ3LTAuMzMxLDIuNzY2LTAuNTM2LDQuMjQtMC41NiBjMC43NDEtMC4wMTIsMC44NjEtMC4wNTksMC44NjEtMC4wNTljMS4wMjItMC4xNywxLjY5NS0wLjg2OSwxLjQxNC0xLjk3NmMtMC4yNTItMS4xMy0xLjU3OS0xLjc5NS0yLjg0LTEuNTY1IGMtMS4xODgsMC4yMTctNC4wNSwxLjA0OC00LjA1LDEuMDQ4YzMuNTM5LTAuMDMxLDQuMTMxLDAuMDI4LDQuMzk1LDAuMzk4YzAuMTU2LDAuMjE4LTAuMDcxLDAuNTE4LTEuMDE1LDAuNjcyIGMtMS4wMjcsMC4xNjgtMy4xNjMsMC4zNy0zLjE2MywwLjM3Yy0yLjA0OSwwLjEyMi0zLjQ5MiwwLjEzLTMuOTI1LDEuMDQ2QzYuMjAyLDcuNTY0LDYuNzg3LDguMDk0LDcuMDQzLDguNDI1IGMxLjA4MiwxLjIwNCwyLjY0NiwxLjg1MywzLjY1MiwyLjMzMWMwLjM3OSwwLjE4LDEuNDksMC41MiwxLjQ5LDAuNTJjLTMuMjY1LTAuMTgtNS42MTksMC44MjMtNy4wMDEsMS45NzcgYy0xLjU2MiwxLjQ0NS0wLjg3MSwzLjE2OCwyLjMzLDQuMjI4YzEuODkxLDAuNjI2LDIuODI4LDAuOTIxLDUuNjQ4LDAuNjY3YzEuNjYxLTAuMDksMS45MjMtMC4wMzYsMS45MzksMC4xIGMwLjAyMywwLjE5Mi0xLjg0NSwwLjY2OS0yLjM1NSwwLjgxNkMxMS40NDgsMTkuNDM4LDguMDQ3LDIwLjE5Myw4LjAzLDIwLjE5N3oiLz48L3N2Zz4="/><text aria-hidden="true" x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="490">Made for</text><text x="475" y="140" transform="scale(.1)" fill="#fff" textLength="490">Made for</text><text aria-hidden="true" x="1125" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="650">GNU Emacs</text><text x="1125" y="140" transform="scale(.1)" fill="#fff" textLength="650">GNU Emacs</text></g></svg>
\ No newline at end of file
-- 
cgit v1.2.3