Name		Name	Last commit message	Last commit date
parent directory ..
Images		Images
CI.md		CI.md
Doxyfile.in		Doxyfile.in
MuditaCppCodingGuidelines.md		MuditaCppCodingGuidelines.md
README.md		README.md
adding_unittests.md		adding_unittests.md
balenaetcher1.png		balenaetcher1.png
balenaetcher2.png		balenaetcher2.png
balenaetcher3.png		balenaetcher3.png
balenaetcher4.png		balenaetcher4.png
boot_and_update.md		boot_and_update.md
build_targets.md		build_targets.md
changelog_howto.md		changelog_howto.md
database_v2.md		database_v2.md
development_workflow.md		development_workflow.md
download_assets.md		download_assets.md
flashing_win_macos.md		flashing_win_macos.md
host_keyboard_bindings.md		host_keyboard_bindings.md
howto_simulator.md		howto_simulator.md
i18n.md		i18n.md
quickstart.md		quickstart.md
release.md		release.md
running_on_phone.md		running_on_phone.md
secure_boot.md		secure_boot.md
setup_ide.md		setup_ide.md
static_analysis.md		static_analysis.md
tethering.md		tethering.md
update_on_boot.md		update_on_boot.md

README.md

MuditaOS Documentation

This folder contains the documentation of the MuditaOS.

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