summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAgathe Porte <microjoe@microjoe.org>2018-05-08 12:14:14 +0200
committerAgathe Porte <microjoe@microjoe.org>2018-05-21 18:13:51 +0200
commit51292127a47911f973e1c2691a9adc75c6bad044 (patch)
tree57bfa6a687cc5255074957a705850c324b5b1462 /README.rst
parent2774d9fc67cd5d18fbc9b892fda9c05118272a7a (diff)
downloadlatex-makefile-51292127a47911f973e1c2691a9adc75c6bad044.tar.gz
latex-makefile-51292127a47911f973e1c2691a9adc75c6bad044.zip
Simpler version of Makefilev1.0
Instead of using a big .gitignore and a big clean target, we can tell latexmk to build into a dedicated directory. This way, all temporary files are located in a repository that we just have to ignore and remove. This allows us to have the .tex sources right next to the Makefile, which makes it easier to reason about instead of having to use the src/ subdirectory. Also moved README to reStructuredText (because Markdown sucks IMO) and removed gif and fancy badges in the README.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..d4d1d61
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,19 @@
+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!