summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/codedoc/README
blob: 78683eaf23017870c50aea3c3088bc26e5616fe3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
This is the file README for the CodeDoc class, v.0.3.
You'll find complete documentation in CodeDoc-manual.pdf

This class produces code and documentation in a single file without departing from LaTeX's ordinary
syntax.


TO PRODUCE THE DOCUMENTATION:
Run LaTeX on CodeDoc-manual.tex (better in PDF).
In the document class options of the latter file,
you may uncomment the `obeystop' option and/or
comment out the `index' option to remove the
implementation from the documentation and/or
the index.
Don't forget to run LaTeX and MakeIndex as many
times as necessary.

TO PRODUCE THE CLASS ITSELF (codedoc.cls):
Uncomment the `produce' option among the
class options and run LaTeX on the same file
(CodeDoc-manual.tex).
This serves as an illustration only, since
to do so you already need codedoc.cls, obviously.
This file should thus be included in any distribution.


Licensing of this package is covered by LPPL.

Any reaction is welcome: zappathustra@free.fr

Paul Isambert