aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-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`.