~aleteoryx/muditaos

ref: 51c3dd2261d3645a297a88126fb9a1b6bded74e6 muditaos/doc/README.md -rw-r--r-- 2.7 KiB
51c3dd22 — Bartosz Cichocki [EGD-8019] Clean docker build scripts 4 years ago

#MuditaOS Documentation

This folder contains the documentation of the MuditaOS.

#How to generate documentation using Doxygen

Fully detailed documentation can be built locally 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