0 Fork 0

mirror of https://github.com/mudita/MuditaOS.git synced 2026-10-26 16:38:31 -04:00

Files

T

Lucjan Bryndza e5948375e0 [EGD-6188] Add PurePhone flash script

Currently dd doesn't handle sparse files properly,
so the mudita pure flashing script should be used
on the linux platform instad of the dd command.

Tools will be created in the build dir
example usage is: pureflash <image_file> <block_device>

2021-03-18 09:31:04 +01: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

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

Added links, corrected small typos, etc. (#809 )

2020-10-09 13:23:07 +02:00

i18n.md

[EGD-5787] Fixes re fallback font docs

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

quickstart.md

[EGD-5989] Update quickstart article

2021-03-16 09:26:04 +01:00

README.md

Add two links to table of contents (#1169 )

2020-12-11 09:49:57 +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

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

README.md

MuditaOS Documentation

How to generate documentation using Doxygen

Table of contents