summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/dox/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/dox/README')
-rw-r--r--Master/texmf-dist/doc/latex/dox/README38
1 files changed, 24 insertions, 14 deletions
diff --git a/Master/texmf-dist/doc/latex/dox/README b/Master/texmf-dist/doc/latex/dox/README
index 5356e7a7b6d..a856f77065d 100644
--- a/Master/texmf-dist/doc/latex/dox/README
+++ b/Master/texmf-dist/doc/latex/dox/README
@@ -18,7 +18,6 @@ DoX consists of the following files:
- README (this file)
- NEWS
-- THANKS
- dox.ins
- dox.dtx
- dox.el
@@ -28,31 +27,42 @@ DoX consists of the following files:
=============
The doc package provides LaTeX developers with means to describe the usage and
-the definition of new macros and environments. However, there is no simple way
-to extend this functionality to other items (options or counters for
-instance). The DoX package is designed to circumvent this limitation. DoX also
-comes with support for AUC-TeX.
+the definition of new commands and environments. However, there is no simple
+way to extend this functionality to other items (options or counters for
+instance). DoX is designed to circumvent this limitation, and provides some
+improvements over the existing functionality as well.
+
+DoX homepage: http://www.lrde.epita.fr/~didier/software/latex.php#dox
* Installation
==============
- To install the package, please follow these steps:
+If you are building DoX from the tarball you need to execute the following
+steps in order to extract the necessary files:
+
+[pdf]latex dox.ins
+[pdf]latex dox.dtx
+[pdf]latex dox.dtx
+
+After that, you need to install the generated documentation and style file to
+a location where LaTeX can find them. For a TDS-compliant layout, the
+following locations are suggested:
+
+[TEXMF]/tex/latex/dox/dox.sty
+[TEXMF]/doc/latex/dox/dox.[pdf|dvi]
-- Run LaTeX on the file `dox.ins' to create the style file `dox.sty'.
-- Run LaTeX on the file `dox.dtx' to create the documentation.
-- Install these files anywhere you see fit.
+If you're an AUC-TeX user, you may also install the file 'dox.el' in a
+suitable AUC-TeX style directory.
- If you're an AUC-TeX user, you can also install the file `dox.el' in
-a suitable AUC-TeX style directory.
Have fun!
--
-Didier Verna, didier@lrde.epita.fr, http://www.lrde.epita.fr/~didier
+Didier Verna <didier@lrde.epita.fr>
-EPITA / LRDE, 14-16 rue Voltaire Tel.+33 (0)1 44 08 01 85
-94276 Le Kremlin-Bicêtre, France Fax.+33 (0)1 53 14 59 22
+Sientific site: http://www.lrde.epita.fr/~didier
+Music (Jazz) site: http://www.didierverna.com