# PIXELIX <!-- omit in toc -->
![PIXELIX](./images/LogoBlack.png)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)

# Documentation  <!-- omit in toc -->

- [Requirements](#requirements)
- [Hardware](#hardware)
- [Software](#software)
- [Issues, Ideas And Bugs](#issues-ideas-and-bugs)
- [License](#license)
- [Contribution](#contribution)

# Requirements

* [Requirements](REQUIREMENTS.md)

# Hardware

* [Boards](./boards/README.md)
* [Sensors](SENSORS.md)

# Software

* [Software architecture](./architecture/README.md)
* [Software configuration management](./config/README.md)
    * [Toolchain installation](./config/TOOLCHAIN-INSTALLATION.md)
    * [Software build](./config/SW-BUILD.md)
    * [Software update](./config/SW-UPDATE.md)
* [Plugins](PLUGINS.md)
* [Plugin Development](PLUGIN-DEV.md)
* [REST API description](https://app.swaggerhub.com/apis/BlueAndi/Pixelix/1.3.0)
* [MQTT](MQTT.md)
* [Home Assistant REST Wrapper](HOMEASSISTANT.md)
* [Websocket API description](WEBSOCKET.md)
* [Sprite sheet](SPRITESHEET.md)
* [Alternative icons](ICONS.md)

# Issues, Ideas And Bugs
If you have further ideas or you found some bugs, great! Create a [issue](https://github.com/BlueAndi/esp-rgb-led-matrix/issues) or if you are able and willing to fix it by yourself, clone the repository and create a pull request.

# License
The whole source code is published under the [MIT license](http://choosealicense.com/licenses/mit/).
Consider the different licenses of the used third party libraries too!

# Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any
additional terms or conditions.
