Skip to content

Commit

Permalink
Merge branch 'documentation'
Browse files Browse the repository at this point in the history
  • Loading branch information
cayennes committed Mar 24, 2012
2 parents 96c6ff8 + 74bc8f9 commit ca7bdb2
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## About

kanji-colorize, which will be available soon, is a script for coloring, resizing, and renaming the stroke order diagrams from the [http://kanjivg.tagaini.net/](KanjiVG) project. I wrote it to create sets that make it possibe to easily add stroke order diagrams to an [http://ankisrs.net/](anki) kanji deck, but they can be used for anything you want some nicely colored stroke order diagrams for.
kanji-colorize, which will be available soon, is a script for coloring, resizing, and renaming the stroke order diagrams from the [KanjiVG](http://kanjivg.tagaini.net/) project. I wrote it to create sets that make it possibe to easily add stroke order diagrams to an [anki](http://ankisrs.net/) kanji deck, but they can be used for anything you want some nicely colored stroke order diagrams for.

For now, there are some sets stroke order diagrams generated with it.

## Getting diagrams

If you just want some colorted diagrams, go to [https://github.com/cayennes/kanji-colorize/downloads](Downloads). I've packaged up a spectrum set and a contrast set. The spectrum set colors the strokes in rainbow order and is nice because the you can see at a glance how the kanji is put together, but has the disadvantage that stokes next to each other are similar colors, and color is sometimes necessary to tell which number goes with which stroke. The contrast set maximizes the contrast between any set of consecutive strokes. (This uses the golden ratio. Math is nifty.)
If you just want some colorted diagrams, go to [Downloads](https://github.com/cayennes/kanji-colorize/downloads). I've packaged up a spectrum set and a contrast set. The spectrum set colors the strokes in rainbow order and is nice because the you can see at a glance how the kanji is put together, but has the disadvantage that stokes next to each other are similar colors, and color is sometimes necessary to tell which number goes with which stroke. The contrast set maximizes the contrast between any set of consecutive strokes. (This uses the golden ratio. Math is nifty.)

## Using with Anki

Expand All @@ -16,10 +16,10 @@ To add these to a kanji deck:
2. Add `<img src={{{text:Kanji}}}.svg>` to your card template, where Kanji is the name of a field that contains a single kanji character.
3. If you use anki on multiple devices, you may need to run "Tools >> Advanced >> Check Media Database..." to get them to sync properly. If you want to clear out the unused SVGs, which there will be a ton of, use scan + delete. But use scan if you will be adding any more kanji to your deck, or you'll have to add the SVGs to your media folder again.

I have submitted a post to [http://www.japaneselevelup.com](Japanese Level Up) which will have more tips on using stroke order diagrams in an anki deck, and examples of these diagrams. I expect it to be available to read within a few days.
There are examples of the diagrams and more on using stroke order diagrams with anki in [this Japanese Level Up post](http://japaneselevelup.com/2012/03/24/boosting-ankis-power-with-media-enhancements-4-colorful-stroke-order-diagrams/).

## Feedback

If there's anything you think would improve these, you can use the [https://github.com/cayennes/kanji-colorize/issues](issue tracker) or email me at cayennes@gmail.com.
If there's anything you think would improve these, you can use the [issue tracker](https://github.com/cayennes/kanji-colorize/issues) or email me at cayennes@gmail.com.

If you find any errors in image files you download, check to see whether they have been fixed in the KanjiVG data by looking at [http://kanjivg.tagaini.net/viewer.html](their online kanji viewer). If it is correct there, it means that I didn't notice that there was an update; let me know and I'll fix it. If the error exists there, let the KanjiVG project know using their [https://github.com/KanjiVG/kanjivg/issues](issue tracker).
If you find any errors in image files you download, check to see whether they have been fixed in the KanjiVG data by looking at [their online kanji viewer](http://kanjivg.tagaini.net/viewer.html). If it is correct there, it means that I didn't notice that there was an update; let me know and I'll fix it. If the error exists there, let the KanjiVG project know using their [issue tracker](https://github.com/KanjiVG/kanjivg/issues).

0 comments on commit ca7bdb2

Please sign in to comment.