summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..05e8912
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# A super LaTeX Makefile for large reports
+
+Feel free to use this Makefile in order to render your LaTeX report easier!
+
+## Description
+
+This Makefile uses `latexmk`, a tool that will manage any dependencies between
+LaTeX files and run the LaTeX render multiple times if needed. This is
+especially useful when you use a table of content, a glossary, or anything
+that need the LaTeX engine to run multiple times before rendering a correct
+output.
+
+## License
+
+Everything in this repository is released under WTFPL, so yeah, do whatever
+you want. Spread this tool in order to allow people to use LaTeX for
+everything!