aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2022-12-28 11:43:26 +0100
committerlonkaars <loek@pipeframe.xyz>2022-12-28 11:43:26 +0100
commitec000fcbb7e721bfd2638427d54f56f2dae76316 (patch)
treeca71b2b42caea628cc7cca8bf1961a92830aadb8 /readme.md
parentc0f41dd4c74ca4a12252103da0e6de296533e269 (diff)
rename to refold-tools
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md71
1 files changed, 4 insertions, 67 deletions
diff --git a/readme.md b/readme.md
index 9de275d..ef78a39 100644
--- a/readme.md
+++ b/readme.md
@@ -1,70 +1,7 @@
-# anki sentence mining template
+# refold tools
-work in progress
+this is a repo with language learning stuff:
-this is an anki card template for sentence mining. it has fields for a foreign
-sentence, foreign word, translated word and an optional translated sentence. it
-supports a markdown-like [syntax](#syntax) for adding furigana that is visible
-on either both sides or only on the back side.
-
-## example
-
-### input
-
-|Field|Value|
-|-|-|
-|Complete sentence|`[家](うち)の{主}(あるじ)を*なめるなよ*…`|
-|Target word reading|`舐める【なめる】`|
-|Target word translation|`To underestimate`|
-|Complete sentence translation|`Don't underestimate the master of the house...`|
-
-### front
-
-<div class="card front" align="center" style="border: solid 2px gray; padding: 10px;">
-<span class="sentence parsed">家の<ruby>主<rt class="visible">あるじ</rt></ruby>を<b>なめるなよ</b>…</span>
-</div>
-
-### back
-
-<div class="card back" align="center" style="border: solid 2px gray; padding: 10px;">
-<span class="sentence parsed"><ruby>家<rt class="hidden">うち</rt></ruby>の<ruby>主<rt class="visible">あるじ</rt></ruby>を<b>なめるなよ</b>…</span>
-<hr class="split">
-<span class="target-word-reading">舐める【なめる】</span><br>
-<span class="target-word-translation">To underestimate</span><br>
-<span class="sentence-translation">Don't underestimate the master of the house...</span>
-</div>
-
-## syntax
-
-html is passed through, so inline styling (should) still work.
-
-|input|html output|example|
-|-|-|-|
-|`[kanji](furigana)`|`<ruby>kanji<rt>furigana</rt></ruby>`<br>(furigana visible on back side only)|<ruby>kanji<rt>furigana</rt></ruby>|
-|`{kanji}(furigana)`|`<ruby>kanji<rt>furigana</rt></ruby>`<br>(furigana visible on both sides)|<ruby>kanji<rt>furigana</rt></ruby>|
-|`*text*`|`<b>text</b>` (bold)|<b>text</b>|
-|`a\nb`|`a<br>b` (line break)|a<br>b|
-|`\\`|`\` (backslash)|\\|
-|`\[escaped](this)`|`[escaped](this)` (escaped furigana)|\[escaped](this)|
-
-## set-up
-
-i don't know how to create a teplate deck (if that's even a thing), so these
-are instructions to apply to an empty deck.
-
-1. run `make` to generate files
-2. Under Tools > Manage note types > (note type here) > Fields, make sure the
- following fields exist (might be case-sensitive):
- | |name|description|
- |-|----|-----------|
- |1|Complete sentence|Complete sentence with furigana and target word in bold|
- |2|Target word reading|Dictionary reading of word (with word type)|
- |3|Target word translation|(In context) translation of target word|
- |4|Complete sentence translation|Complete sentence translation|
-3. In the 'Browse' view, click on Cards... (you might need to create a
- temporary card in a deck) and paste the contents of front-template.html and
- back-template.html in the front template and back template of the card type.
- Make sure the Styling tab doesn't contain any code as this will override the
- built-in styles.
-4. Profit
+- [anki sentence mining card template](anki-card-temlate)
+- [yomichan theme](yomichan)