aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorH. Peter Anvin (Intel) <hpa@zytor.com>2020-06-30 13:47:17 -0700
committerH. Peter Anvin (Intel) <hpa@zytor.com>2020-06-30 13:47:17 -0700
commit39714f7de7524acfb731bb9dd1c2c5b3ca1e80c6 (patch)
tree04f37601db2459edbd046ff0c461758bf2955d8b /doc
parent4ddeb70428842a21c2f7628714df22c94e5acf17 (diff)
downloadnasm-39714f7de7524acfb731bb9dd1c2c5b3ca1e80c6.tar.gz
nasm-39714f7de7524acfb731bb9dd1c2c5b3ca1e80c6.tar.xz
nasm-39714f7de7524acfb731bb9dd1c2c5b3ca1e80c6.zip
doc: document(!) documentation build requirements
The tools we need to build the documentation. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/nasmdoc.src13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/nasmdoc.src b/doc/nasmdoc.src
index 00b8c3ae..04cf8a87 100644
--- a/doc/nasmdoc.src
+++ b/doc/nasmdoc.src
@@ -8737,8 +8737,9 @@ the \c{git} distributed source control system. The link is available
on the website. This is recommended only to participate in the
development of NASM or to assist with testing the development code.
-To build NASM from the \c{git} repository you will need a Perl and, if
-building on a Unix system, GNU autoconf.
+To build NASM from the \c{git} repository you will need a Perl
+interpreter and, if building on a Unix system, GNU autoconf installed
+on your system.
To build on a Unix system, run:
@@ -8746,6 +8747,14 @@ To build on a Unix system, run:
to create the \c{configure} script and then build as listed above.
+\H{builddoc} Building the documentation
+
+To build the documentation, you will need a Perl interpreter, a
+Postscript to PDF converter such as Ghostscript, and suitable fonts
+installed on your system. The recommended (and default) fonts are
+Adobe's Source Sans and Source Code fonts, which are freely available
+under the SIL Open Font License.
+
\A{contact} Contact Information
\H{website} Website