aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fl.fischer@fau.de>2020-09-16 00:24:34 +0200
committerFlorian Fischer <florian.fl.fischer@fau.de>2020-10-18 14:28:12 +0200
commit4e288bc4a4c171cea7a59cb47fe88049fe4c4f92 (patch)
tree2df4a58b0b77fa158dcbc364b9f3339326102865
parent61bf06995731b882996ec3fda65a220c0ac4d9b4 (diff)
downloadmuhqs-game-4e288bc4a4c171cea7a59cb47fe88049fe4c4f92.tar.gz
muhqs-game-4e288bc4a4c171cea7a59cb47fe88049fe4c4f92.zip
add simple README documenting how to generate latex cards and build them
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
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`.