diff options
Diffstat (limited to 'Carpet/doxygen/README')
| -rw-r--r-- | Carpet/doxygen/README | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/Carpet/doxygen/README b/Carpet/doxygen/README new file mode 100644 index 000000000..746fc0270 --- /dev/null +++ b/Carpet/doxygen/README @@ -0,0 +1,16 @@ +$Header: /home/eschnett/C/carpet/Carpet/Carpet/doxygen/README,v 1.1 2003/11/05 21:04:37 schnetter Exp $ + +This directory contains, in CVS, the Doxygen configuration file. The +generated documentation will also be placed here, but should not go +into CVS. + +Create the Doxygen configuration by running the command + + doxygen doxygen/Doxyfile + +from one directory up, i.e. from the Carpet arrangement directory. +This will create html documentation in a subdirectory html, and latex +documentation in a subdirectory latex. The latex subdirectory +contains a makefile that creates pdf from the latex sources. + +-erik |