Update README and Makefile for the latexmk existence check

Signed-off-by: Chun-Hung Tseng <henrybear327@gmail.com>

diff --git a/Makefile b/Makefile
index d1ef984008984d2e83993a9bc93198218b49f585..022866241046c7fe4ca0463df9ab57467ddff3c3 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -2,6 +2,7 @@ PROJ = lkmpg
 all: $(PROJ).pdf
 
 $(PROJ).pdf: lkmpg.tex
+       @if ! hash latexmk; then echo "No Latexmk found. See https://mg.readthedocs.io/latexmk.html for installation."; exit 1; fi
        rm -rf _minted-$(PROJ)
        latexmk -shell-escape lkmpg.tex -pdf
 

diff --git a/README.md b/README.md
index 1413423479c994de8018f99cd8054de30002e67a..bf558940835b6f80db5491f01ade914c10e20b2a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -40,6 +40,8 @@ $ brew install --cask mactex
 $ sudo tlmgr update --self
 ```
 
+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).
+
 Alternatively, using [Docker](https://docs.docker.com/) is recommended, as it guarantees the same dependencies with our GitHub Actions workflow.
 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.