aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPeter Carbonetto2017-05-24 22:13:22 -0500
committerPeter Carbonetto2017-05-24 22:13:22 -0500
commit8dcaade55867f0459122431872289758fa1116bb (patch)
tree67a5e44ceb0c4fe11e47b0ed27e4b22653d5d4fc /doc
parent7e9be21ef63fdbf3aa882e43e29d9bc9f43607a8 (diff)
downloadpangemma-8dcaade55867f0459122431872289758fa1116bb.tar.gz
Added doc/Makefile.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile19
-rw-r--r--doc/README.md9
2 files changed, 27 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..9638a4f
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,19 @@
+# A Makefile for generating the PDF from Latex. Simply type 'make' in
+# this directory to compile the Latex into a single PDF. Type 'make
+# clean' to discard the output files except for the generated PDF.
+
+# RULES
+# -----
+all: manual.pdf
+
+# Create the PDF file.
+manual.pdf : manual.tex manual.bib
+ pdflatex manual
+ bibtex manual
+ pdflatex manual
+ pdflatex manual
+
+clean:
+ rm -f manual.aux manual.bbl manual.blg
+ rm -f manual.log manual.out manual.toc
+
diff --git a/doc/README.md b/doc/README.md
index 760d64a..7687e81 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -4,13 +4,20 @@ The following commands will generate a PDF of the GEMMA manual from
the Latex:
```bash
+cd doc
pdflatex manual
bibtex manual
pdflatex manual
pdflatex manual
```
+Alternatively, you can use the Makefile:
+
+```bash
+cd doc
+make
+```
+
To run these commands, you will need a TeX distribution such as
[TexLive](https://www.tug.org/texlive) that includes commands
`pdflatex` and `bibtex`.
-