Commit acd4534a authored by Toby's avatar Toby
Browse files

add documentation requirements and generation instructions

parent 34e71b89
# doxygen-example
A silly C program example to demonstrate doxygen
## Requirements
- Doxygen
- GraphViz (dot) [optionally]
- make [on *nix]
If generating PDFs:
- PDF-LaTeX (I use MikTex). This may ask for permission, and install sub packages
during a make operation
- Ghostscript
## Generate documentation
- To generate doxygen documentation run:
```
doxygen ./doxygen/Doxyfile
```
Generate HTML will be located in the location specified by the Doxyfile, in this
case `./doxygen/documentation/html`.
- If also generating a PDF, an extra step is required:
- On Windows:
```
> ./doxygen/documentation/latex/make.bat
```
- On *nix:
```
$ make all -C ./doxygen/documentation/latex/
```
The resulting PDF is named refman.pdf and is placed in the latex directory.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment