aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>2017-05-02 12:54:37 -0700
committerH. Peter Anvin <hpa@zytor.com>2017-05-02 13:01:59 -0700
commit735883692d08724c8ba07859d4393ec989e262da (patch)
tree89ebb2c18617879af040f0d3096a8f581c0c7b4b /doc
parent13ff7f92ecca0e8e62eb1e1d19d9c99de1f8f6da (diff)
downloadnasm-735883692d08724c8ba07859d4393ec989e262da.tar.gz
nasm-735883692d08724c8ba07859d4393ec989e262da.tar.xz
nasm-735883692d08724c8ba07859d4393ec989e262da.zip
Document/update dependencies for the documentation
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/README b/doc/README
new file mode 100644
index 00000000..63956224
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,20 @@
+To build the entire documentation, the following tools are needed:
+
+1. A Perl interpreter for your platform
+2. The following Perl modules available from CPAN:
+ Font::TTF
+ Sort::Versions
+3. asciidoc
+ http://asciidoc.org/
+4. xmlto
+ https://fedorahosted.org/xmlto
+5. One of:
+ Adobe Acrobat (acrodist)
+ Ghostscript (ps2pdf) http://download.ghostscript.com/
+ pstopdf (available on some BSD-derived Unix systems)
+
+ Of these, Ghostscript is the most tested, although Acrobat has
+ been claimed to generate smaller files.
+6. For best results, the Adobe fonts Source Sans Pro and Source Code
+ Pro, available for free at:
+ https://github.com/adobe-fonts