next up previous contents index
Next: 4. Compilation & installation Up: 3. CO5BOLD file overview Previous: 3.3 Script files   Contents   Index

3.4 Documentation files

The files in Tab.3.7 provide various information. Among them is the general README file and the LATEX source of the CO5BOLD manual. PDF and HTML versions of the manual are not included and have to be compiled individually (by executing mk_co5bold).

Table 3.7: List of documentation files.
Path (and files) Description
README CO5BOLD installation instructions
README_MHD Short description of MHD parameters
doc/examples/ReadMe Description of some CO5BOLD parameter files
doc/examples/*.par Some CO5BOLD sample parameter files
doc/info/*.txt A mix of info files (release notes, todo list,...)
doc/manual/co5bold.tex The LATEX source of the manual
uio/man/man1/ man pages for UIO scripts, see Sect.6.2.6