mirror of https://github.com/mudita/MuditaOS.git synced 2026-04-19 06:30:46 -04:00

Files

Adam Dobrowolski 2fed826c28 [EGD-7947] Unified aproach for download_asset

Improved timing. Uses cached file for both json and direct
downloads if possible.
Improved logging. Clear information what's being downloaded.
Removed older script.

2021-11-18 16:16:25 +01:00

Images

Fix transparent backgrounds in PlantUML

2021-08-16 17:01:19 +02:00

adding_unittests.md

[EGD-7445] Removed dead scripts

2021-09-20 12:58:45 +02: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-7253] Fix broken links and remove HTML anchors

2021-10-27 14:55:27 +02:00

development_workflow.md

[EGD-7253] Fix broken links and remove HTML anchors

2021-10-27 14:55:27 +02:00

download_assets.md

[EGD-7947] Unified aproach for download_asset

2021-11-18 16:16:25 +01: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-943] Fix screen clean after exit

2021-10-15 11:34:20 +02:00

howto_simulator.md

doc/howto_simulator.md: Add details on how to unlock simulator

2021-09-02 13:37:19 +02:00

i18n.md

[EGD-5787] Fixes re fallback font docs

2021-02-17 14:03:46 +01:00

MuditaCppCodingGuidelines.md

[EGD-6761] Added the C++ coding guidelines

2021-10-08 16:10:59 +02:00

quickstart.md

[EGD-7826] Update quickstart readme

2021-11-10 09:38:09 +01:00

README.md

[EGD-7253] Fix broken links and remove HTML anchors

2021-10-27 14:55:27 +02:00

release.md

[EGD-3734] Rewriting release.md (#792 )

2020-10-08 13:38:10 +02:00

running_on_phone.md

[EGD-7253] Fix broken links and remove HTML anchors

2021-10-27 14:55:27 +02:00

secure_boot.md

[CP-288] Update secureboot documentation

2021-07-16 09:40:29 +02:00

setup_ide.md

[EGD-7253] Fix broken links and remove HTML anchors

2021-10-27 14:55:27 +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

Getting Started Guides
Developer Guides
- Coding Guidelines
- System architecture
- Modules
  - Applications
    - Desktop
    - Notifications
  - Audio
  - Bluetooth
  - Database
  - Filesystem
  - GUI
  - Modem
  - System
- Services
- Tools
  - MapParser
  - PureGDB
Development workflow
- Creating release
Contributing
Internationalization
Changelog
- HOWTO
- Latest changelog

README.md

MuditaOS Documentation

How to generate documentation using Doxygen

Table of contents