~aleteoryx/muditaos

ref: b38adceced4bf4960c436fb0e4b71910a6bfb9c4 muditaos/doc/README.md -rw-r--r-- 2.1 KiB
b38adcec — Adam Dobrowolski [EGD-6019] Minimum settings ownership lifetime fixups 4 years ago

#MuditaOS Documentation

Thid folder contains everything you need to kickstart your development environment for MuditaOS.

A fully detailed documentation can be build locally using Doxygen.

#How to generate documentation using Doxygen

You can build code documentation with the following command:

make doc

If you prefer to build documentation always with all target instead, configure cmake with BUILD_DOC_WITH_ALL option set to ON, e.g.:

cmake -DBUILD_DOC_WITH_ALL=ON . build/

Documentation is generated in the doc/html subdirectory of the build directory. To view it open index.html using a web browser, e.g.:

firefox build/doc/html/index.html

#Table of contents