summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorJan Tuomi <jan.tuomi@valuemotive.com>2020-11-19 22:33:18 +0200
committerJan Tuomi <jan.tuomi@valuemotive.com>2020-11-19 22:33:18 +0200
commit75c731c78880c5a31a50e166d33dcae03b76349a (patch)
treeeb87160816e3f9a50456f9f924b658cbf5f0602b /README.rst
Initial commit
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..76ced8a
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,16 @@
+========================================
+Attain Corp. vocabulary file to Anki CSV
+========================================
+
+Automatically construct CSV with Kanji, Hiragana, English, and Kanji meanings that can be fed to Anki.
+Kanji meanings are scraped from Jisho.
+
+Usage
+=====
+
+Run ``poetry install`` to install dependencies. Run ``poetry run main file.csv`` to run the script on the file ``file.csv``.
+
+Author
+======
+
+Jan Tuomi, <jans.tuomi@gmail.com>