~aleteoryx/muditaos

a405cad694b867fcd2498984830bd97d4b9bde2f — Aleteoryx 5 days ago 2cd0e47 hacking
trim readme
1 files changed, 7 insertions(+), 58 deletions(-)

M README.md
M README.md => README.md +7 -58
@@ 1,62 1,11 @@
# MuditaOS

[![Follow Twitter](https://img.shields.io/twitter/follow/wearemudita?label=Follow%20on%20Twitter&style=social)](https://twitter.com/wearemudita)

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

![MuditaOS interface screenshots](doc/Images/readme_header.jpg)

## Products

There are two released products based on MuditaOS:
1. [PurePhone](https://store.mudita.com/mudita-pure-minimalist-phone) - low distraction phone with rich [key features](products/PurePhone/ProductKeyFeatures.md)
2. [Mudita Harmony](https://store.mudita.com/mudita-harmony-your-healthy-bedtime-habits) - eink based distraction free alarm clock.

## Table of contents

* [Contributing](#Contributing)
   * [Discussions](#Discussions)
   * [Reporting issues and feature requests](#Reporting-bugs-and-feature-requests)
   * [Internationalization](#Internationalization)
   * [Development environment setup](#development-envioronment-setup)
   * [Development workflow](#Development-workflow)
* [Documentation](#documentation)
* [License](#license)

## Contributing

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

### Discussions

For general questions and ideas regarding MuditaOS please post in the [“MuditaOS” section on Mudita Forum](https://forum.mudita.com/c/MuditaOS/). 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](https://github.com/mudita/MuditaOS/issues). 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"](CONTRIBUTING.md) article for more details.

### Internationalization

If you want to start localizing MuditaOS interface please start from [the "Internationalization" article](doc/i18n.md).

### Development environment setup

To develop MuditaOS please follow guide on [environment setup](doc/quickstart.md#Quickstart)

### Development workflow

When contributing code or documentation changes please follow the guidelines inside the ["Development workflow"](doc/development_workflow.md) article.

## Documentation

For everything you need to kick-start your development environment please go to the [Documentation](doc/README.md) on GitHub.

A fully detailed documentation can be build locally using [Doxygen](https://www.doxygen.nl/index.html).

## Changelog

The [MuditaOS changelog - Pure edition](pure_changelog.md) describes releases of the Pure's version of MuditaOS.
Description of Harmony's version of the OS can be found here: [MuditaOS changelog - Harmony edition](harmony_changelog.md)
[see upstream][upstream]. I'm thinking about getting a mudita pure,
and I have some things I'd like to hack into the firmware. so here we
are.

## License
MuditaOS is licensed under [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/).
MuditaOS is licensed under GNU GPLv3. as a result, so are all my
escapades.

[upstream]: https://github.com/mudita/muditaos