README.md (1750B)
1 # omoidasu - ζγεΊγ 2 3 A collection of scripts for working with 4 [oboeru](https://github.com/rnpnr/oboeru) 5 6 ## Installation 7 8 Use `make` to install (using root as needed): 9 10 make install 11 12 Scripts are installed to `PREFIX=/usr/local` by default. 13 14 ## Directory Structure 15 16 These scripts assume a directory structure as follows: 17 18 ./ 19 config 20 deck1.deck 21 deck1.data 22 deck1/ 23 cardid1/ 24 front.md 25 back.md 26 image.png 27 audio.ogg 28 extra.html 29 cardid2/ 30 ... 31 deck2.deck 32 deck2.data 33 deck2/ 34 ... 35 ... 36 37 ## Scripts 38 39 All scripts in this repo should work with standard POSIX compliant core 40 utils. If they don't open an issue. 41 42 * `omoidasu`: creates a default `config` in the current directory. 43 * `gencard`: creates a new card and associated directory for the specified 44 deck and opens the front and back in an `$EDITOR`. 45 * `deck2data`: converts the front and back of the card to the data format 46 expected by oboerudata 47 * `review`: ties all the programs together starts reviews on the specified decks 48 * `fetchcard`: takes the deck and id output by oboeru and finds the cards path 49 * `nextcardid`: finds the next available id in a supplied deck file 50 51 The following are specific for studying Japanese: 52 53 * `furigana`: uses `kakasi` and `sed` to convert text on stdin into furigana 54 reading pairs expected by `rubify`. 55 * `rubify`: converts furigana reading pairs from `furigana` into html ruby text 56 57 ## Extra 58 59 The tag `==EXTRA==` can be used on the card to inject the file 60 `extra.html` into the output html. It can be used to keep the cards 61 clean and readable when you want to include something complicated like 62 a pitch graph.