diff options
-rw-r--r-- | .gitignore | 18 | ||||
-rw-r--r-- | Makefile | 41 | ||||
-rw-r--r-- | README.md | 26 | ||||
-rw-r--r-- | README.rst | 19 | ||||
-rw-r--r-- | docs/demo.gif | bin | 319449 -> 0 bytes | |||
-rw-r--r-- | main.tex (renamed from src/main.tex) | 0 |
6 files changed, 32 insertions, 72 deletions
@@ -1,17 +1 @@ -*.aux -*.fdb_latexmk -*.fls -*.glg -*.glo -*.gls -*.glsdefs -*.ist -*.lof -*.log -*.lot -*.out -*.toc -*.xdy -*.tns -*.pdf -*.dvi +build @@ -1,4 +1,4 @@ -# LaTeX basic Makefile +# LaTeX Makefile # # WTFPL, 2016 - 2018 Agathe Porte (MicroJoe) <microjoe@microjoe.org> # @@ -8,47 +8,30 @@ # Very important variables to set up PDF=main.pdf -PRINC=src/main.tex +PRINC=main.tex +AUXDIR=build +LATEXMK=source ~/.bashrc && latexmk \ + -auxdir=$(AUXDIR) \ + -outdir=$(AUXDIR) \ + -pdf -pdflatex="pdflatex -interaction=nonstopmode" -use-make # You want latexmk to *always* run, because make does not have all the info. # Also, include non-file targets in .PHONY so they are run regardless of any # file of the given name existing. -.PHONY: $(PDF) all clean +.PHONY: $(PDF) all clean live # Main rule: Construct the PDF all: $(PDF) -# + # Live: automatic watch and build of the PDF file live: $(PRINC) $(SOURCES) - source ~/.bashrc && latexmk -pvc -pdf -pdflatex="pdflatex -interaction=nonstopmode" -use-make $(PRINC) + $(LATEXMK) -pvc $(PRINC) # Construct the PDF file from sources $(PDF): $(PRINC) $(SOURCES) - source ~/.bashrc && latexmk -pdf -pdflatex="pdflatex -interaction=nonstopmode" -use-make $(PRINC) + $(LATEXMK) $(PRINC) # Remove all the intermediate files clean: @echo Cleaning temporary LaTeX files... - @rm -f \ - *.aux \ - *.fdb_latexmk \ - *.fls \ - *.glg \ - *.glo \ - *.gls \ - *.glsdefs \ - *.ist \ - *.lof \ - *.log \ - *.lot \ - *.out \ - *.toc \ - *.xdy - @echo Done - -mrproper: clean - @echo Removing all PDF files... - @rm -f *.pdf - @echo Removing all DVI files... - @rm -f *.dvi - @echo Done + @rm -rf build diff --git a/README.md b/README.md deleted file mode 100644 index d00cba4..0000000 --- a/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# A super LaTeX Makefile for large reports - -![License: WTFPL](https://img.shields.io/badge/license-WTFPL-blue.svg) - -Feel free to use this Makefile in order to render your LaTeX report easier! - -![Animated GIF demo of the Makefile](docs/demo.gif) - -## 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. - -*Be sure to use the provided .gitignore file too!* This will allow you to -use git without versionning various temporary files that LaTeX produces during -generation. Maybe all temporary files extensions are not covered. You are -welcome to send me `.patch` files! - -## 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! 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! diff --git a/docs/demo.gif b/docs/demo.gif Binary files differdeleted file mode 100644 index 7910629..0000000 --- a/docs/demo.gif +++ /dev/null |