#MuditaOS

MuditaOS is a mobile operating system optimized for E Ink displays. Built from scratch with Mudita Pure minimalist phone in mind.

#Table of contents

• Quickstart
• Contributing
  • Discussions
  • Reporting issues and feature requests
  • Development workflow
• Documentation
  • How to generate documentation using Doxygen
• License

#Quickstart

You can quickstart the project by going through one of the following guides:

• Quickstart using Docker
• Building your own Docker image
• Quickstart in your local environment
• Longstart
• Super dirty quickstart on Linux
• Super dirty quickstart with unit tests
• Super dirty quickstart on the phone
• Preparing packages

#Contributing

Pull requests are welcome. Please follow the guidelines in the "Contributing to MuditaOS" article. Before contributing or starting a discussion, please make sure that you read our Code of Conduct.

#Discussions

For general questions and ideas regarding MuditaOS please post in the “MuditaOS” section on Mudita Forum. Please explore all existing posts to make sure you’re not posting about an issue that has already been discussed.

#Reporting bugs and feature requests

You can report bugs and feature requests on GitHub. This is also a good place to discuss architecture decisions and things that aren’t yet covered by the documentation. Please refer to the "Contributing to MuditaOS" article for more details.

#Development workflow

When contributing code or documentation changes please follow the guidleines inside the "Development workflow" article.

#Documentation

For everything that you need to kickstart your development environment please go to the Documentation folder on Github.

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:

./configure linux Debug
cd build-linux-Debug
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.:

./configure <target> <build_type> -DBUILD_DOC_WITH_ALL=ON

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-<target>-<build_type>/doc/html/index.html

#Changelog

The MuditaOS changelog is regularly updated by the core development team.

#License

MuditaOS is licensed on GPL3.