diff options
Diffstat (limited to 'trunk/doc/tex/README.txt')
| -rw-r--r-- | trunk/doc/tex/README.txt | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/trunk/doc/tex/README.txt b/trunk/doc/tex/README.txt new file mode 100644 index 000000000..460d330a0 --- /dev/null +++ b/trunk/doc/tex/README.txt @@ -0,0 +1,24 @@ +Asterisk Reference Documentation +-------------------------------- + +1) To generate a PDF from this documentation, you will need the rubber tool, + and all of its dependencies. The web site for this tool is: + + http://www.pps.jussieu.fr/~beffara/soft/rubber/ + + Then, once this tool is installed, running "make pdf" will generate + the PDF automatically using this tool. The result will be asterisk.pdf. + + NOTE: After installing rubber, you will need to re-run the top level + configure script. It checks to see if rubber is installed, so that the + asterisk.pdf Makefile target can produce a useful error message when it is + not installed. + +2) To generate HTML from this documentation, you will need the latex2html tool, + and all of its dependencies. The web site for this tool is: + + http://www.latex2html.org/ + + Then, once this tool is installed, running "make html" will generate the + HTML documentation. The result will be an asterisk directory full of + HTML files. |