restructured readme, clarified some things

This commit is contained in:
Alexander Bocken 2020-11-20 14:45:41 +01:00
parent b900388a7f
commit 35c16f0ba0
Signed by: Alexander
GPG Key ID: 1D237BE83F9B05E8

View File

@ -5,20 +5,18 @@
<img src="/../assets/german_front.png" alt="Front side with german word displayed" width="49%"> <img src="/../assets/german_back.png" alt="Back side revealing kanji with that meaning" width="49%">
This is my personal vocab list to learn the Japanese Kanji which is using J.W. Heisig/R. Rauther's [__"Die Kanji - lernen und behalten 1"__](https://www.amazon.de/Bedeutung-Schreibweise-japanischen-Schriftzeichen-behalten/dp/3465041577/ref=sr_1_2?crid=2LX7RDRS8FEGW&dchild=1&keywords=die+kanji+lernen+und+behalten&qid=1595191168&sprefix=Die+kanji+lern%2Caps%2C154&sr=8-2)
I'm using Anki as my vocab program with the Addon [CrowdAnki](https://github.com/Stvad/CrowdAnki) to export in a diff-friendly json-file. You can easily add it to yout Anki setup via the code given on [its AnkiWeb page](https://ankiweb.net/shared/info/1788670778).
From there it's a simple `File -> CrowdAnki: Import git repository`.
Since I'm using the German version of the book (and my native language is German) the cards are Japanese-German.
I'm following the guide of the book, only implementing hints if I have troubles with memorizing the words.
Feel free to base your vocab list off of mine via a fork, that's probably the best way to go ahead.
## Disclaimer
All cards have now been added.
Hints are only sporadically used and can only be expected for difficult kanjis in the first few hundred cards for now.
## Import
To get the Kanji unicode characters I used this [Kanji recognition site](https://kanji.sljfaq.org/draw-canvas.html).
Seems a lot faster than having to rely on Google Translate (plus I don't have to use Google, which is a benefit in itself.)
I'm using Anki as my vocab program with the Addon [CrowdAnki](https://github.com/Stvad/CrowdAnki) to export in a diff-friendly json-file.
You can easily add it to yout Anki setup via the code given on [its AnkiWeb page](https://ankiweb.net/shared/info/1788670778).
From there it's a simple `File -> CrowdAnki: Import git repository`.
If you're using different Anki applications, please see the release section for `.apkg` files.
These will not be as up to date as the `json` files used by CrowndAnki.
## Contributing
@ -32,6 +30,13 @@ This deck is maintained using the [CrowdAnki](https://github.com/Stvad/CrowdAnki
4. Use `Export -> CrowdAnki Json representation` on the deck and chose the repository's base directory.
5. Commit the changes, and submit a pull request to this repository.
### Disclaimer
Hints are only sporadically used and can only be expected for difficult kanjis in the first few hundred cards for now.
To get the Kanji unicode characters I used this [Kanji recognition site](https://kanji.sljfaq.org/draw-canvas.html).
Seems a lot faster than having to rely on Google Translate (plus I don't have to use Google, which is a benefit in itself.)
## Primitves
I've been adding the seperately listed primitives as well, although that has some issues connected with it: Some/most of the primitives listed seperately do not have a unicode character associated with them. Thus I've been using two strategies:
@ -40,23 +45,17 @@ I've been adding the seperately listed primitives as well, although that has som
Both of these strategies are not optimal and I'm currently looking into other options. Inserting pictures does not seem optimal to me as well since those are heavily font-dependent. Reccommendations on how to solve this issue are always welcome.
## Compounds
Compounds are added to the last kanji learned to completely understand the compound.
## Composites
Composites are added to the last kanji learned to completely understand the composite.
E.g. "週末" (Wochenende) is added at "週" (no. 340), not "末" (no. 230).
## Fonts
For Kanjis I'm using the IPAGothic font, for the stroke order I'm using Timothy Eyre's great font I found on [his website](https://www.nihilist.org.uk/). Please notice the license he has listed for this font.
### Importing via apkg
I've included an apkg file with the font files included as well as one apkg file without these font files.
Choose the one you prefer, the one with fonts has the additional benefit of synchronising the fonts with other devices.
### Importing via CrowdAnki
Either install these fonts seperately or add the ttfs to your `collection.media` Anki folder as `_ipag.ttf` and `_KanjiStrokeOrders.ttf`.
The latter method has the benefit of synchronising these fonts to your other devices as well.
For Kanjis I'm using the IPAGothic font, for the stroke order I'm using Timothy Eyre's (or is it Ulrich Apel's? It's not quite clear to me.) great font I found on [his website](https://www.nihilist.org.uk/).
The licenses for these fonts can also be found in the `licenses` folder of this git repository.
I believe me distributing these fonts with this project is not a breach of contract, but I am also not a lawyer.
## License
MIT
(Fonts seperate)