Commit edf9ab1e authored by Maxime Bombar's avatar Maxime Bombar

Update documentation

parent 0c7f3f5c
......@@ -5,8 +5,10 @@
# Maxime Bombar <bombar@crans.org>
## This Makefile is used to build pdf from a latex project. Use ```make help``` to display a summary of the rules.
## ```make MyFancyProject.pdf``` will build MyFancyProject.pdf (and auxiliary files) from MyFancyProject.tex and fail if it doesn't exist.
##
## make MyFancyProject.pdf : Builds MyFancyProject.pdf (and auxiliary files) from MyFancyProject.tex and fails if it doesn't exist.
## make MyFancyProject.warn : Displays how many warnings and bad boxes there are when compiling MyFancyProject.
## make MyFancyProject.showwarn : Displays the warnings and bad boxes for MyFancyProject.
.PHONY: docs help clean cleanall
......@@ -47,17 +49,14 @@ warnings: main.tex
@echo "${shell echo 'There are $$($(CMDMAIN) $(REGEXBOX) | wc -l)' bad boxe\(s\)}"
## showwarnings : Display all warnings and bad boxes that are found when compiling main.tex
showwarnings: main.pdf
$(PDFLATEX) $<
@echo "${shell echo $(\n)}"
@echo "${shell echo 'There are $$(( $$($(CMDMAIN) $(WARNINGS) | wc -l)-1 ))' warning\(s\):}"
@echo "${shell echo '$$( $(CMDMAIN) $(WARNINGS) | tail +2)' }"
@echo "${shell echo $(\n)}"
@echo "${shell echo 'There are $$($(CMDMAIN) $(REGEXBOX) | wc -l)' bad boxe\(s\):}"
@echo "${shell echo '$$( $(CMDMAIN) $(REGEXBOX))' }"
## make all : Builds every file in the current directory.
all: $(TEXDOCS)
$(PDFLATEX) $^
## make rebuild : Cleans and rebuilds every file.
rebuild: cleanall all
## clean : remove auto-generated files but not pdf.
## make clean : Removes every auto-generated file except for pdf.
clean:
@echo -n "aux bbl blg dvi fdb_latexmk fls tdo toc"|xargs -t -d ' ' -n 1 -I {} find . -iname "*.{}" -delete
rm -f $(OUT)
......@@ -67,10 +66,10 @@ clean:
find . -iname "\#*" -delete
find . -type d -iname 'auto' -exec rm -rf {} +
## cleanall : remove all auto-generated files.
## make cleanall : Removes every auto-generated file.
cleanall: clean
rm -f $(PDF)
## help : display this help.
## make help : Displays this help.
help: Makefile
@sed -n 's/^##//p' $<
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment