Skip to content

Commit

Permalink
doc: document(!) documentation build requirements
Browse files Browse the repository at this point in the history
The tools we need to build the documentation.

Signed-off-by: H. Peter Anvin (Intel) <[email protected]>
  • Loading branch information
H. Peter Anvin (Intel) committed Jun 30, 2020
1 parent 4ddeb70 commit 39714f7
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions doc/nasmdoc.src
Original file line number Diff line number Diff line change
Expand Up @@ -8737,15 +8737,24 @@ 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:

\c sh autogen.sh

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
Expand Down

0 comments on commit 39714f7

Please sign in to comment.