mirror/MuditaOS
1
0
Fork 0
mirror of https://github.com/mudita/MuditaOS.git synced 2026-04-24 17:09:39 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
87ed83ca5ce1209cd4591fc58d16e441928b147c
MuditaOS/doc
History
Marek Niepieklo a906ec6422 [CP-411] Add updater.bin to Update package 
Packaging updater.{bin, ver} using embedded assets
2021-08-04 14:08:08 +02:00
..
Images
added screenshots
2020-10-15 15:51:41 +02:00
adding_unittests.md
[EGD-4763] Add documentation on how to add unit tests
2021-02-04 16:45:50 +01:00
balenaetcher1.png
[EGD-6092] Create Pure flashing guide
2021-03-15 14:37:28 +01:00
balenaetcher2.png
[EGD-6092] Create Pure flashing guide
2021-03-15 14:37:28 +01:00
balenaetcher3.png
[EGD-6092] Create Pure flashing guide
2021-03-15 14:37:28 +01:00
balenaetcher4.png
[EGD-7131] Flashing instruction updated
2021-07-13 12:18:12 +02:00
boot_and_update.md
[BH-353] Add minimal build target for BH
2021-06-07 17:05:29 +02:00
build_targets.md
[BH-353] Add Documentation for main targets
2021-06-11 09:07:41 +02:00
changelog_howto.md
Added links, corrected small typos, etc. (#809)
2020-10-09 13:23:07 +02:00
CI.md
[EGD-6537] Create Jenkins CI
2021-04-23 16:45:23 +02:00
database_v2.md
[EGD-6728] Documentation cleanup
2021-05-19 16:29:54 +02:00
development_workflow.md
[EGD-3390] Add integration with clang-tidy
2021-01-21 10:56:40 +01:00
download_assets.md
[CP-411] Add updater.bin to Update package
2021-08-04 14:08:08 +02:00
Doxyfile.in
[BH-375] Clean module-utils/third-party
2021-07-15 16:55:16 +02:00
flashing_win_macos.md
[EGD-7131] Flashing instruction updated
2021-07-13 12:18:12 +02:00
host_keyboard_bindings.md
[BH-351] Simulator input handling
2021-05-19 14:25:19 +02:00
howto_simulator.md
[EGD-6554] Fix emulator to simulator
2021-04-16 14:19:25 +02:00
i18n.md
[EGD-5787] Fixes re fallback font docs
2021-02-17 14:03:46 +01:00
quickstart.md
[BH-353] Add Documentation for main targets
2021-06-11 09:07:41 +02:00
README.md
[EGD-6212] Add tethering doc
2021-07-14 09:56:42 +02:00
release.md
[EGD-3734] Rewriting release.md (#792)
2020-10-08 13:38:10 +02:00
running_on_phone.md
[EGD-6188] Add PurePhone flash script
2021-03-18 09:31:04 +01:00
secure_boot.md
[CP-288] Update secureboot documentation
2021-07-16 09:40:29 +02:00
setup_ide.md
Added links, corrected small typos, etc. (#809)
2020-10-09 13:23:07 +02:00
static_analysis.md
[EGD-3390] Add integration with clang-tidy
2021-01-21 10:56:40 +01:00
tethering.md
[EGD-6212] Add tethering doc
2021-07-14 09:56:42 +02:00
update_on_boot.md
added screenshots
2020-10-15 15:51:41 +02:00

README.md

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

Reference in New Issue View Git Blame Copy Permalink