0
0
mirror of https://github.com/netwide-assembler/nasm.git synced 2025-07-24 10:25:42 -04:00
Cyrill Gorcunov a384068a04 doc: latex -- Initial import
It is an initial import for conversion of our documentation
to latex format. Note that latex additional packages needs
to be preinstalled, xelatex is used for pdf generation.

While I've been very carefull while converting the docs there
is a big probability that some indices might be screwed so
we need to review everything once again.

Then we need to create a converter for html backend, I started
working on it but didn't successed yet and I fear won't have
enough spare time in near future.

Also we need to autogenerate instruction table and warnings
from insns.dat and probably from scanning nasm sources.

To build nasm.pdf just run

	make -C doc/latex/

it doesn't require configuration and rather a standalone
builder out of our traditional build engine.

Signed-off-by: Cyrill Gorcunov <gorcunov@gmail.com>
2019-03-31 19:34:50 +03:00
..
2019-03-31 19:34:50 +03:00
2012-02-25 14:53:34 -08:00
2018-06-25 23:13:59 -07:00

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