mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-27 03:39:55 +00:00
57 lines
3.4 KiB
Markdown
57 lines
3.4 KiB
Markdown
|
|
|
|
<p style="text-align: center">
|
|
<a href="http://choosealicense.com/licenses/mit">
|
|
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
|
|
</a>
|
|
<img src="https://img.shields.io/github/workflow/status/michmich/magicmirror/Run%20Automated%20Tests" alt="GitHub Actions">
|
|
<img src="https://img.shields.io/github/checks-status/michmich/magicmirror/master" alt="Build Status">
|
|
<a href="https://codecov.io/gh/MichMich/MagicMirror">
|
|
<img src="https://codecov.io/gh/MichMich/MagicMirror/branch/master/graph/badge.svg?token=LEG1KitZR6" alt="CodeCov Status"/>
|
|
</a>
|
|
<a href="https://github.com/MichMich/MagicMirror">
|
|
<img src="https://img.shields.io/github/stars/michmich/magicmirror?style=social">
|
|
</a>
|
|
</p>
|
|
|
|
**MagicMirror²** is an open source modular smart mirror platform. With a growing list of installable modules, the **MagicMirror²** allows you to convert your hallway or bathroom mirror into your personal assistant. **MagicMirror²** is built by the creator of [the original MagicMirror](https://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MichMich/MagicMirror/graphs/contributors).
|
|
|
|
MagicMirror² focuses on a modular plugin system and uses [Electron](https://www.electronjs.org/) as an application wrapper. So no more web server or browser installs necessary!
|
|
|
|
## Documentation
|
|
|
|
For the full documentation including **[installation instructions](https://docs.magicmirror.builders/getting-started/installation.html)**, please visit our dedicated documentation website: [https://docs.magicmirror.builders](https://docs.magicmirror.builders).
|
|
|
|
## Links
|
|
|
|
- Website: [https://magicmirror.builders](https://magicmirror.builders)
|
|
- Documentation: [https://docs.magicmirror.builders](https://docs.magicmirror.builders)
|
|
- Forum: [https://forum.magicmirror.builders](https://forum.magicmirror.builders)
|
|
- Technical discussions: https://forum.magicmirror.builders/category/11/core-system
|
|
- Discord: [https://discord.gg/J5BAtvx](https://discord.gg/J5BAtvx)
|
|
- Blog: [https://michaelteeuw.nl/tagged/magicmirror](https://michaelteeuw.nl/tagged/magicmirror)
|
|
- Donations: [https://magicmirror.builders/#donate](https://magicmirror.builders/#donate)
|
|
|
|
## Contributing Guidelines
|
|
|
|
Contributions of all kinds are welcome, not only in the form of code but also with regards to
|
|
|
|
- bug reports
|
|
- documentation
|
|
- translations
|
|
|
|
For the full contribution guidelines, check out: [https://docs.magicmirror.builders/getting-started/contributing.html](https://docs.magicmirror.builders/getting-started/contributing.html)
|
|
|
|
## Enjoying MagicMirror? Consider a donation!
|
|
|
|
MagicMirror² is opensource and free. That doesn't mean we don't need any money.
|
|
|
|
Please consider a donation to help us cover the ongoing costs like webservers and email services.
|
|
If we receive enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.
|
|
|
|
To donate, please follow [this](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G5D8E9MR5DTD2&source=url) link.
|
|
|
|
<p style="text-align: center">
|
|
<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
|
|
</p>
|