From 4e288bc4a4c171cea7a59cb47fe88049fe4c4f92 Mon Sep 17 00:00:00 2001
From: Florian Fischer <florian.fl.fischer@fau.de>
Date: Wed, 16 Sep 2020 00:24:34 +0200
Subject: add simple README documenting how to generate latex cards and build
 them

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d4745346
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Generate latex cards
+
+To generate all latex files for the cards in the base set run:
+
+```shell
+scripts/generate_latex.py data/base.ini --latex-root=latex
+```
+
+All base cards in latex/cards will be regenerated.
+
+
+# Building cards
+
+The Makefile in `latex` is used to build pdfs and or pngs from the latex files in `latex/cards`.
+Enter the `latex` directory and run:
+```shell
+make
+```
+
+The build files will be in `/latex/build`.
-- 
cgit v1.2.3