From 16fe2e9eb019d87adb9656888c8e49c4a526dfd3 Mon Sep 17 00:00:00 2001 From: Chun-Hung Tseng Date: Fri, 18 Mar 2022 19:56:25 +0100 Subject: [PATCH] Update README and Makefile for the latexmk existence check Signed-off-by: Chun-Hung Tseng --- Makefile | 1 + README.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/Makefile b/Makefile index d1ef984..0228662 100644 --- 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 1413423..bf55894 100644 --- 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.