From 637e707a1ab7efa62234a374c62ffb040800aca8 Mon Sep 17 00:00:00 2001 From: Cheng-En Lee Date: Fri, 26 Aug 2022 19:14:17 -0700 Subject: [PATCH] Add additional macos installation instruction in README.md (#157) Signed-off-by: Cheng-En Lee --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bf55894..4ce885e 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ $ 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). +In macOS systems, package `Pygments` may not be pre-installed. If not, please refer to the [installation guide](https://pygments.org/download/) before generate documents. + 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.