Skip to content

Commit 16fe2e9

Browse files
committed
Update README and Makefile for the latexmk existence check
Signed-off-by: Chun-Hung Tseng <[email protected]>
1 parent d27d2c2 commit 16fe2e9

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

Makefile

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ PROJ = lkmpg
22
all: $(PROJ).pdf
33

44
$(PROJ).pdf: lkmpg.tex
5+
@if ! hash latexmk; then echo "No Latexmk found. See https://mg.readthedocs.io/latexmk.html for installation."; exit 1; fi
56
rm -rf _minted-$(PROJ)
67
latexmk -shell-escape lkmpg.tex -pdf
78

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ $ brew install --cask mactex
4040
$ sudo tlmgr update --self
4141
```
4242

43+
Note that `latexmk` is required to generated PDF, and it probably has been installed on your OS already. If not, please follow the [installation guide](https://mg.readthedocs.io/latexmk.html#installation).
44+
4345
Alternatively, using [Docker](https://docs.docker.com/) is recommended, as it guarantees the same dependencies with our GitHub Actions workflow.
4446
After install [docker engine](https://docs.docker.com/engine/install/) on your machine, pull the docker image [twtug/lkmpg](https://hub.docker.com/r/twtug/lkmpg) and run in isolated containers.
4547

0 commit comments

Comments
 (0)