README

   1 This is sispare-qt: SImple SPAced REpetition (QT version). You can use
   2 it to do spaced repetition with flash cards with a modified version of
   3 the Leitner system[1]. I wrote sispare[2] because I don't think Anki
   4 should be 100MB+ of code, and I wrote sispare-qt because I was sick of
   5 squinting at my terminal to read the kanji.
   6
   7 You need
   8
   9  - Qt5 [ https://www.qt.io/ ]
  10
  11  - A C++ compiler that supports C++20
  12
  13 To use it, run
  14
  15    /path/to/sispare-qt [ -d <dir> ]
  16
  17 The <dir> argument defaults to ${XDG_DATA_HOME}/sispare or
  18 ${HOME}/.sispare .
  19
  20 Sispare-qt is mostly controlled by the data directory. It expects the
  21 following layout:
  22
  23    /path/to/sispare/dir/
  24     + cards/
  25     | + card_000/
  26     | | + side_A
  27     | | + side_B
  28     | | + level
  29     | + card_001/
  30     | | + side_A
  31     | | + side_B
  32     | | + level
  33     | + whatever name you like/
  34     |   + side_A
  35     |   + side_B
  36     |   + level
  37     + schedule/
  38       + 2031-08-12
  39       + 2031-08-13
  40       + 2031-08-16
  41
  42 When sispare-qt starts a session, it reads all the files in schedule/
  43 whose names correspond to the current date or earlier. Each line in
  44 those files will be something like "card_000" or "whatever name you
  45 like".
  46
  47 All of those lines are collected and shuffled. For each line, the sides
  48 of the corresponding card will be displayed in a window. If the user
  49 marks the card as successfully remembered, the value stored in that
  50 card's level file will be increased, which influences how much time
  51 passes before the card is next reviewed. If the user marks the card as
  52 failed, that card's level is reset to 1, and if the card is marked as
  53 remembered with difficulty, the card's level is slightly reduced.
  54
  55 TODOs:
  56
  57  - Decide on correct behavior for deleted cards, and possibly add a
  58    deletion option to the GUI. See the TODO in session.cc
  59
  60  - Implement card-adding from within the GUI. Currently I do that using
  61    the CLI client, but it should be doable from here too. Better, even,
  62    because the GUI will let me provide nice text entry boxes.
  63
  64 [1] https://en.wikipedia.org/wiki/Leitner_system
  65 [2] https://repo.or.cz/sispare.git