Add "Overview" section to documentation.md
dkl9

dkl9 commited on 2024-1 11:14:27
Showing 1 changed files, with 11 additions and 0 deletions.

... ...
@@ -2,6 +2,17 @@ Memoire is a [spaced repetition]( https://en.wikipedia.org/wiki/Spaced_repetitio
2 2
 I made it largely out of frustration with the slow performance of Anki.
3 3
 It is primarily for my own use and may well be too idiosyncratic or mediocre to benefit you.
4 4
 
5
+## Overview
6
+Here's how you memorise knowledge with Memoire, roughly the same as with any spaced repetition program:
7
+1. [Set up Memoire.]( #setup )
8
+1. Learn something.
9
+2. Distill knowledge into one or more [notes, suitable for cards]( #data-format ).
10
+3. [Add those cards]( #adding-cards ) to your deck.
11
+4. [Review]( #review-in-the-terminal ) your deck every day (or a bit more or less often, if needed) as Memoire directs.
12
+5. [Correct]( #correcting-cards ) notes when you realise they're wrong or unhelpful.
13
+6. Repeat steps 1-3 whenever appropriate.
14
+7. Be a genius (well, maybe).
15
+
5 16
 ## Data format
6 17
 Any time you run Memoire, it will operate on a deck.
7 18
 A deck is stored as a [Recfile]( https://www.gnu.org/software/recutils/manual/The-Rec-Format.html ).
8 19