mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-07-02 22:08:42 +00:00
5eed80c28e
commit e38dd346d9f796807ea71035c18e3533ec245ba6
Author: Michael Teeuw <michael@xonaymedia.nl>
Date: Sat Apr 2 19:17:30 2016 +0200
Add the possibility to set the maximum number of days.
commit 6f5c86775b708d19d3798267ffd23e491a1d2c62
Author: Sam Vendittelli <sam.vendittelli@hotmail.com>
Date: Sat Apr 2 06:27:44 2016 +0100
Fixed cursor appearing in margin
Cursor was appearing in the margin so moved `cursor: none` property to html.
commit 576c668d84b34b8ad7a0fd51b146fde60f721682
Author: Domi-G <lessuseguy+githubdomig@gmail.com>
Date: Fri Apr 1 22:52:32 2016 +0200
Huge cleanup of white space
56 lines
2.5 KiB
Markdown
56 lines
2.5 KiB
Markdown
# MagicMirror V2
|
|
This version of the Magic Mirror software focusses on a modular plugin system. Besides that, the Magic Mirror software now also uses [Electron](http://electron.atom.io/), so no more webserver or browser installs necessary.
|
|
|
|
#WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH.
|
|
|
|
<<<<<<< HEAD
|
|
##Usage
|
|
1. Download the latest node version:
|
|
`wget https://nodejs.org/dist/latest/node-v5.10.0-linux-armv6l.tar.gz` for Pi 1
|
|
`wget https://nodejs.org/dist/latest/node-v5.10.0-linux-armv7l.tar.gz` for Pi 2
|
|
2. Unpack file `tar -xvf filename`
|
|
3. Install `cd foldername && sudo cp -R * /usr/local/`
|
|
4. Set loglevel `npm config set loglevel info`
|
|
5. `npm install && npm start` (You may have to restart your terminal before this works)
|
|
|
|
**Important:** `npm start` does NOT work via SSH you have to execute it in a terminal session running in a window-manager.
|
|
=======
|
|
##Usage
|
|
1. Install [Node.js](https://nodejs.org/en/)
|
|
2. Execute `npm install && npm start`.
|
|
>>>>>>> v2-beta
|
|
|
|
##Configuration
|
|
1. Duplicate `config/config.js.sample` to `config/config.js`.
|
|
2. Modify your required settings.
|
|
|
|
##Todo
|
|
Things that still have to be implemented or changed.
|
|
|
|
####Main
|
|
- Allow show/hide animations to animate the height. This way the other modules won't jump around.
|
|
- Unified alerts (Blocking overlay & slide in notification) maybe using this [library](http://tympanus.net/Development/NotificationStyles/js/notificationFx.js) (from [this](http://tympanus.net/Development/NotificationStyles/growl-jelly.html) example) and [sweetalert](https://github.com/t4t5/sweetalert) for blocking?
|
|
|
|
####Documentation
|
|
- Write all the documentation. :)
|
|
|
|
##Modules
|
|
|
|
### Default modules:
|
|
- [**Clock**](modules/default/clock)
|
|
- [**Calendar**](modules/default/calendar)
|
|
- [**Current Weather**](modules/default/currentweather)
|
|
- [**Weather Forecast**](modules/default/weatherforecast)
|
|
- [**News Feed**](modules/default/newsfeed)
|
|
- [**Compliments**](modules/default/compliments)
|
|
- [**Hello World**](modules/default/helloworld)
|
|
- [**Alert**](modules/default/alert)
|
|
|
|
### 3rd Party Modules:
|
|
|
|
- **[MMM-FRITZ-Box-Callmonitor by PaViRo](https://github.com/paviro/MMM-FRITZ-Box-Callmonitor)** <br> FRITZ!Box Callmonitor (Display an alert when someone is calling ...)
|
|
|
|
- **[MMM-Facial-Recognition by PaViRo](https://github.com/paviro/MMM-Facial-Recognition)** <br> Facial recognition and module swapping based on the current user ...
|
|
|
|
- **[MMM-Wunderlist by PaViRo](https://github.com/paviro/MMM-Wunderlist)** <br> Displays your Wunderlist todos on your mirror ...
|