added README

2020-01-19 20:40:13 +01:00
parent 4d7b744f6b
commit 66dadce353
1 changed files with 16 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,16 @@
+# Latex Spellcard generator
+
+This script generates spellcard from a certain format of json.
+There is an example in `data/sample.json`.
+
+The cards are compact and could be printed on A4 (10 per page).
+
+The end result looks like this:
+
+![Sample](sample.png)
+
+## Calling
+
+```
+python genspells.py --spells data/sample.json -2 Wizard
+```