Add list of known issues.

This commit is contained in:
Michael Teeuw
2016-04-11 11:35:56 +02:00
parent 3543ebb9a6
commit 88166b7c73

View File

@@ -11,13 +11,14 @@
MagicMirror² focuses on a modular plugin system and uses [Electron](http://electron.atom.io/) as an application wrapper. So no more web server or browser installs necessary! MagicMirror² focuses on a modular plugin system and uses [Electron](http://electron.atom.io/) as an application wrapper. So no more web server or browser installs necessary!
**WARNING!** This version is in a early stage. It is **not** completed yet. **Please** use the master branch. **WARNING!** This version is in a early beta stage. **Please** use the master branch if you need a thoroughly tested version.
## Table Of Contents ## Table Of Contents
- [Usage](#usage) - [Usage](#usage)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Modules](#modules) - [Modules](#modules)
- [Known Issues](#known-issues)
- [Contributing Guidelines](#contributing-guidelines) - [Contributing Guidelines](#contributing-guidelines)
## Usage ## Usage
@@ -98,6 +99,11 @@ The following modules are created by their respective authors.
**Note:** If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](modules) **Note:** If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](modules)
## Known issues
- Electron seems to have some issues on certain Raspberry Pi 2's. See [#145](https://github.com/MichMich/MagicMirror/issues/145).
- MagicMirror² (Electron) sometimes quits without an error after an extended period of use. See [#150]( See https://github.com/MichMich/MagicMirror/issues/150).
## Contributing Guidelines ## Contributing Guidelines
Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation. Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation.