mirror/MuditaOS
1
0
Fork 0
mirror of https://github.com/mudita/MuditaOS.git synced 2026-06-14 19:45:31 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
e71a044bd3f7df980802cdcdb29ad48c9cd427df
MuditaOS/doc
History
Bartosz Cichocki fabf1944e0 [EGD-6258] Add CMake options to the Quick Start 
Added description of CMake options used during generation
2021-05-11 11:52:05 +02:00
..
Images
added screenshots
2020-10-15 15:51:41 +02:00
Scripts
[EGD-3743] Update copyrights in fies
2020-10-20 12:55:10 +02:00
UML
[EGD-2332] Development workflow minimal docs
2019-12-05 14:30:39 +01: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
boot_and_update.md
[EGD-6188] Add PurePhone flash script
2021-03-18 09:31:04 +01: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-2974] Support for temporary contacts as a group
2020-09-15 15:04:10 +02:00
development_workflow.md
[EGD-3390] Add integration with clang-tidy
2021-01-21 10:56:40 +01:00
download_assets.md
[EGD-4627] Add target for ecooboot.bin download
2020-12-15 09:09:23 +01:00
Doxyfile.in
EGD-4202 Adding missing images gui docs (#935)
2020-10-29 13:18:46 +01:00
flashing_win_macos.md
[EGD-5965] Add BT-Harness API documentation
2021-03-15 15:17:14 +01:00
host_keyboard_bindings.md
[EGD-6515] Answer/reject calls using headset
2021-04-15 14:19:50 +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
[EGD-6258] Add CMake options to the Quick Start
2021-05-11 11:52:05 +02:00
README.md
[EGD-6238] Write Pure simulator guide
2021-03-22 15:52:58 +01: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
[EGD-6355] Adjust MuditaOS to be used with Secure Boot
2021-04-22 15:02:59 +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
update_on_boot.md
added screenshots
2020-10-15 15:51:41 +02:00

README.md

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

Reference in New Issue View Git Blame Copy Permalink