org-drill/README.md, branch mainSpaced-repetition flashcards for Org Mode
https://git.cjennings.net/org-drill/atom?h=main2026-05-05T15:10:30+00:00docs: rewrite README as a slim modernized front-door2026-05-05T15:10:30+00:00Craig Jenningsc@cjennings.net2026-05-05T15:10:30+00:00urn:sha1:6bb7f9b91304847d92222bf25ca6021fd82d468d
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).
docs: clarify fork status in README2026-04-29T13:25:48+00:00Craig Jenningsc@cjennings.net2026-04-29T13:25:48+00:00urn:sha1:c7661142575b8a1cf09606d0ef115b0e3a0df90f
Add a top note that flags this as a maintained fork with applied upstream patches, and a bottom note clarifying that the existing Author and History sections describe the original project. Helps anyone who lands on the GitHub mirror without context.
Add blank line between authors in README2019-07-22T16:09:39+00:00Stig Brautasetstig@brautaset.org2019-07-22T16:09:39+00:00urn:sha1:f0bb12bf0b4c072be111d1d7a9b1bffaad596de7Merge branch 'patch-3' into 'master'2019-07-21T20:21:58+00:00Phillip Lordphillip.lord@newcastle.ac.uk2019-07-21T20:21:58+00:00urn:sha1:135a2b9d566a1e1ba5fdb274d1cf797c931c38bd
Update README's installation instructions
See merge request phillord/org-drill!5
Update README's installation instructions2019-07-20T11:05:56+00:00Stig Brautasetstig@brautaset.org2019-07-20T11:05:56+00:00urn:sha1:79726ceb043730601cc23ce728f757a224ee1716Fix typo in function name in README2019-07-20T10:53:00+00:00Stig Brautasetstig@brautaset.org2019-07-20T10:53:00+00:00urn:sha1:4478ca5e9dd7670cad14209d66aec68df7229025Document explainer2019-06-29T16:49:33+00:00Phillip Lordphillip.lord@russet.org.uk2019-06-29T16:49:33+00:00urn:sha1:c44ca7447b9b4f53f568e4d55614a5848717fd78Extend README2019-06-23T09:06:29+00:00Phillip Lordphillip.lord@russet.org.uk2019-06-23T09:06:29+00:00urn:sha1:f72d8adda33108c57c88973aeb25984f30cdc1a2Update README2019-06-21T21:40:07+00:00Phillip Lordphillip.lord@russet.org.uk2019-06-21T21:40:07+00:00urn:sha1:9eb8d72776d95ab8977e5a73523101d816b03a78Explain status of fork2019-06-02T15:36:33+00:00Phillip Lordphillip.lord@russet.org.uk2019-06-02T15:34:59+00:00urn:sha1:6959903b99fce6cbf4db93711e95117fd5cd879d