The doxygen generated pages might be useful for exploring the code an when you want to work with Auryn other than just trying out some of the examples (you find an online version of it here).

To build the doxygen documentation ensure you have doxygen installed. Under debian like distributions that means to install

sudo apt-get install graphviz doxygen

and then to generate the html documentation under doc/html run

cd auryn/src
doxygen

Starting from version v0.8 you need to run: and then to generate the html documentation under doc/html run

cd auryn/doc
doxygen

This will generate the doxygen documentation an place it in the auryn/doc directory.