README (2341B)
1 This is a stupid little flashcard reader for LaTeX files. You probably 2 don't want to use it. It just works for me, that's why I use it. 3 4 `viewer.pl` is the old version using Tk, `viewer2.pl` is the new version 5 using Gtk2. 6 7 The flashcard files are stored in `latex/`. You need to have a master 8 copy of them somewhere else, then run `./gen_cache.pl path/to/flashcards/` 9 to copy the new or changed flashcard files to `latex/` and render them. 10 Note that you need to give the top-level flashcard directory, not the 11 one with the actual flashcards in it. See the repository `flashcard-tools` 12 for a description of the directory structure. 13 14 This uses `pdflatex`, `pdfcrop`, and `pdftoppm` to convert the LaTeX files 15 to PNG, pasting the contents of `defs.tex` (from the flashcard directory) 16 at the beginning before rendering so that the definitions are all there. 17 18 The top line of each flashcard file has the theorem number or something 19 similar, the second line has the front side of the card, and the rest 20 of the lines are the actual content of the card. 21 If the top line has a "|" character, the name of the flashcard to the 22 right of it has to be displayed before this one. This is useful to make 23 chained flashcards in which several flashcards depend on context given 24 in the initial one. The chain will always be shown in order. 25 If you loop a chain, the viewer will stop working because it'll go 26 into an infinite loop. Not my problem. 27 The view count is only increased when "Reveal card" is pressed, so 28 it can be messed up if you skip past one flashcard in a chain and only 29 view the later one. In this case, the chain will still always be shown 30 in order, but the view counts for the flashcards in the chain won't 31 be the same. 32 33 The actual program only has four buttons: 34 35 - "Next card" goes to the next card and increases the view count of the 36 currently viewed card (but only if the back was revealed). 37 - "Next (no view increase)" does the same but never increases the view count. 38 - "Reveal back" reveals the back of the card. 39 - "Reload images" reloads the images from the cache (useful when editing 40 the LaTeX files since you can regenerate the cache and then just 41 reload images). 42 43 The number of times the card was viewed is saved in `config.json`. 44 The "next" buttons choose a random card from the cards that have been 45 viewed the least each time.