From 24952830ccdf75d10d260dc120d1bd2887a5c94a Mon Sep 17 00:00:00 2001 From: Matthew Mott Date: Tue, 4 Oct 2022 20:16:54 +0100 Subject: [PATCH] #6098: mention 'asciidoctor' dependency when building on Linux --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46b2719752..dd0c70890c 100644 --- a/README.md +++ b/README.md @@ -66,8 +66,12 @@ To compile DarkRadiant a number of libraries (with development headers) and a st * libeigen3-dev * libgit2-dev (optional) -This does not include core development tools such as g++ or the git client -to download the sources (use sudo apt-get install git for that). One possible set of packages might be: +To generate the local offline HTML user guide, the `asciidoctor` command must be in your +PATH. This is an optional dependency: if the command is not found, the CMake build will +proceed without building the user guide. + +This does not include core development tools such as g++ or the git client to download the +sources (use sudo apt-get install git for that). One possible set of packages might be: `sudo apt-get install git cmake g++ gettext pkg-config`