ReadMe.md 546 Bytes
Newer Older
1
# Documentation for the Adaptable Input / Output System (ADIOS) v2.1.0
William F Godoy's avatar
William F Godoy committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# Generate Doxygen API

1. Requirements (on Linux install them from your package manager):
	* doxygen http://www.stack.nl/~dimitri/doxygen/
	* graphviz http://www.graphviz.org/
	
2. To generate the Doxygen API documentation under doc/html format (default) from the existing Doxyfile (edit Doxyfile to change options):
	
	```
	$ cd ADIOS2/doc 
	$ doxygen
	``` 

# Documentation links

For a Quick Start, and Contributing to ADIOS 2.0: https://github.com/ornladios/ADIOS2/wiki