summaryrefslogtreecommitdiff
path: root/doc/tex/README.txt
diff options
context:
space:
mode:
authorRussell Bryant <russell@russellbryant.com>2007-07-02 22:27:46 +0000
committerRussell Bryant <russell@russellbryant.com>2007-07-02 22:27:46 +0000
commitdf1a340774efc74f80ab4d99fb01da958d3f18e2 (patch)
tree4c5b7a9ec6daf345dc48805fe38a7d941866ed93 /doc/tex/README.txt
parent94b934c8f66b617b05ccf528781b958e4c312d04 (diff)
* Move LaTeX docs into a tex/ subdirectory of the doc/ dir
* Add a Makefile in doc/tex/ for generating PDF and HTML * Add a README.txt file to doc/tex/ to document which tools are used and what web sites to visit for getting them. * Update build_tools/prep_tarball to put the proper Asterisk version string in the automatically generated PDF for release tarballs git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@72982 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'doc/tex/README.txt')
-rw-r--r--doc/tex/README.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/tex/README.txt b/doc/tex/README.txt
new file mode 100644
index 000000000..460d330a0
--- /dev/null
+++ b/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.