# ReflectOS Core

[![Test](https://github.com/Reflect-OS/core/actions/workflows/test.yml/badge.svg)](https://github.com/Reflect-OS/core/actions/workflows/test.yml)
[![Hex.pm Version](https://img.shields.io/hexpm/v/reflect_os_core.svg?style=flat)](https://hex.pm/packages/reflect_os_core)

## About

ReflectOS is the approachable, configurable, and extensible OS for your smart mirror project.  It is designed to allow anyone to easily install, customize, and enjoy a smart mirror/display - no coding or command line usage required!  Instructions for installing on your device and more details about ReflectOS can be found on the [ReflectOS Firmware](https://github.com/Reflect-OS/firmware) project.

This package provides the set of sections, layouts, and layout managers which ship with the prebuilt ReflectOS Firmware.  

For more information on what these are, refer to the [ReflectOS Firmware](https://github.com/Reflect-OS/firmware) documentation.

If you are interested in building your own extensions for ReflectOS, 
please see the documentation for the [ReflectOS Kernel](https://hexdocs.pm/reflect_os_kernel) library.


## Contributing

Contributions are welcome for this project!  You can 
[open an issue](https://github.com/Reflect-OS/core/issues) to report a bug or request
a feature enhancement.  Code contributions are also welcomed, and can be 
submitted by forking this repository and creating a pull request.