diff options
| author | Craig Jennings <c@cjennings.net> | 2026-05-05 10:21:11 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-05-05 10:21:11 -0500 |
| commit | 36cc02289290de75ad6a9db7b50c14c2bdec9264 (patch) | |
| tree | d298393d03fd180a68262aee31f0eaacdb905de3 | |
| parent | be96465271012b86010b9dee04abea8585dc177c (diff) | |
| download | org-drill-36cc02289290de75ad6a9db7b50c14c2bdec9264.tar.gz org-drill-36cc02289290de75ad6a9db7b50c14c2bdec9264.zip | |
docs: tighten README intro and link org-drill.org references
Removed the second sentence of the intro paragraph and rephrased the
remaining text into a compact two-sentence opener focused on what
org-drill is and how scheduling works.
Both occurrences of org-drill.org in the README are now relative
file: links so a reader on GitHub can click through to the manual.
| -rw-r--r-- | README.org | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -8,7 +8,7 @@ [[https://github.com/cjennings/org-drill/actions/workflows/ci.yml][file:https://github.com/cjennings/org-drill/actions/workflows/ci.yml/badge.svg]] [[https://coveralls.io/github/cjennings/org-drill?branch=main][file:https://coveralls.io/repos/github/cjennings/org-drill/badge.svg?branch=main]] -Org-Drill turns Org Mode headings into flashcards and drills you on them using a spaced-repetition algorithm. You write your cards as plain Org headings, tag them =:drill:=, and =M-x org-drill= walks you through the ones that are due. Ratings (0–5) feed a scheduling algorithm (SM2, SM5, or Simple8) that spaces out future reviews. +Org-Drill is a spaced-repetition flashcard system for Org Mode. Recall ratings (0–5) feed an SM2, SM5, or Simple8 scheduler that picks the next review date. " /Memory is the residue of thought./ " — /Daniel Willingham/ @@ -122,7 +122,7 @@ Sixty seconds from install to first drill: Org-drill will show you each card, wait for you to think of the answer, and let you reveal it with any key. Rate yourself 0 (forgot) to 5 (perfect) — that rating sets when you'll see the card again. -The bundled =org-drill.org= file in this repo is also a working drill deck — open it in Emacs and =M-x org-drill= to see every card type in action. =spanish.org= is another worked example, oriented at language learning. +The bundled [[file:org-drill.org][=org-drill.org=]] file in this repo is also a working drill deck — open it in Emacs and =M-x org-drill= to see every card type in action. =spanish.org= is another worked example, oriented at language learning. ** In-Session Keys :PROPERTIES: @@ -217,7 +217,7 @@ Org-drill started life as a contrib in Org Mode itself (when the Org repo had a This fork picks up where Phil's repo paused. I emailed phillord asking how I could help; if I don't hear back I plan to ask to take over upstream maintenance. Meanwhile bugs are getting fixed here and tests are filling in. -For the deep manual — every card type, every customization, plus a working deck you can drill against to see each card-type in action — open =org-drill.org= in Emacs. +For the deep manual — every card type, every customization, plus a working deck you can drill against to see each card-type in action — open [[file:org-drill.org][=org-drill.org=]] in Emacs. ** License :PROPERTIES: |