MuditaOS Documentation
======================

This folder contains the documentation of the MuditaOS.

## Developer guides

- [Development environment](quickstart.md)
- [Build targets supported by MuditaOS](build_targets.md)
- [Booting and updating MuditaOS](boot_and_update.md)
- [Setting up integrated development environment](setup_ide.md)
- [How to use Mudita Pure simulator](howto_simulator.md)
- [Keybindings on Linux](host_keyboard_bindings.md)
- [Running MuditaOS on a phone](running_on_phone.md)
- [Windows and macOS - flashing Pure with image](flashing_win_macos.md)
- [Test harness](../test/README.md)
- [Tethering](tethering.md)
- [Coding Guidelines](MuditaCppCodingGuidelines.md)

## System documentation

Documentation listed below is system documentation listed depending on where it is.

- System architecture
- Modules
   - [Applications](../module-apps/ModuleApps.md)
        - [Application Desktop](../module-apps/application-desktop/doc/README.md)
        - [Notifications](../module-apps/apps-common/notifications/README.md)
    - [Audio](../module-audio/README.md)
    - [Bluetooth](../module-bluetooth/README.md)
    - Database
        - [Queries](../module-db/queries/README.md)
        - [Tables](../module-db/Tables/README.md)
        - [SMS and Contacts database](database_v2.md)
    - [Filesystem](../module-vfs/README.md)
    - [GUI](../module-gui/README.md)
    - [Modem](../module-cellular/modem/README.md)
    - [System](../module-sys/README.md)
- [Services](../module-services/ModuleServices.md)
    - [Application Manager](../module-services/service-appmgr/doc/README.md)
    - [Bluetooth](../module-services/service-bluetooth/doc/readme.md)
    - [Cellular](../module-services/service-cellular/doc/README.md)
    - [Desktop](../module-services/service-desktop/README.md)
    - [GUI](../module-services/service-gui/doc/README.md)
- Utilities
    - [How to use Logging engine](../module-utils/log/doc/logging_engine.md)
- Tools
    - [MapParser](https://github.com/mudita/misc-tools/blob/master/mapparser/README.md)
    - [PureGDB](https://github.com/mudita/misc-tools/blob/master/puregdb/README.md)
- [System cmake configuration](ProjectConfig.md)
- [Development workflow](development_workflow.md)
- [Contributing](../CONTRIBUTING.md)
- [Internationalization](i18n.md)

## Changelog
- [HOWTO](changelog_howto.md)
- [The latest changelog](../changelog.md)