Skip to content

Commit

Permalink
Adding a readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cameronholiman committed Nov 12, 2019
1 parent 99a9aa8 commit 6b3568f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Kanji Stroke Order Jenerator

## Usage
To use the browser version, just load the [web page](https://mermaid.github.io/stroke-order-diagram/index.html)

To use the cli:
1. Clone the repo
1. Install node (v12 is what I used)
1. `yarn install`
1. `node generate-diagrams.js --dir=<directory to download to> --kanji=<kanji[,kanji]>

The default directory is `downloaded`.

All kanji from WaniKani are committed to this repo in the `kanji` folder and can be accessed from
`https://raw.githubusercontent.com/mermaid/stroke-order-diagram/master/katnji/<5 digit code point>.svg`

EX. for ``, it's code point is `U+4E00`, so the filename is `04e00.svg`, and the url is `https://raw.githubusercontent.com/mermaid/stroke-order-diagram/master/katnji/04e00.svg`

0 comments on commit 6b3568f

Please sign in to comment.