summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorRomain Porte <microjoe@microjoe.org>2018-05-08 12:14:14 +0200
committerRomain Porte <microjoe@microjoe.org>2018-05-21 18:13:51 +0200
commit466801dab680a4491b48854069679f15f7a91b21 (patch)
tree272d8f9b29870c08c3be3336177e872294b0dd0f /README.rst
parent1e1d9ab154d06deb1231a15db27f3b8ea3576a03 (diff)
downloadlatex-makefile-466801dab680a4491b48854069679f15f7a91b21.tar.gz
latex-makefile-466801dab680a4491b48854069679f15f7a91b21.zip
Simpler version of Makefile
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!