~aleteoryx/muditaos

ref: 680c8168e5f9da58f9b5dcdd0cadeea9ea633884 muditaos/doc/README.md -rw-r--r-- 1.5 KiB
680c8168 — Radoslaw Wicik [EGD-3998] New db engine (3.33.0) and vfs passing PRAGMA support back to sqlite 5 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