MagicMirror/README.md

# 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.

##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.

##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.

####Alert
- Vertical centering of alerts
- Rewrite the alert module in vanilla JavaScript

####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 ...
Initial version of the README. 2016-03-27 16:57:20 +02:00			`# MagicMirror V2`
Squashed commit of the following: 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 2016-04-03 19:52:13 +02:00			`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.`
Updated README 2016-03-28 13:47:40 +02:00
Add configuration instructions and todo. 2016-03-29 13:35:55 +02:00			`#WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH.`

Updated README 2016-03-28 13:47:40 +02:00			`##Usage`
Updated install instructions 2016-04-03 17:46:09 +02:00			`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.
Updated README 2016-03-28 13:47:40 +02:00
Add configuration instructions and todo. 2016-03-29 13:35:55 +02:00			`##Configuration`
			1. Duplicate `config/config.js.sample` to `config/config.js`.
			`2. Modify your required settings.`

Updated README 2016-03-28 13:47:40 +02:00			`##Todo`
			`Things that still have to be implemented or changed.`
Add module info to readme. 2016-03-30 15:20:14 +02:00
Add todo. 2016-04-01 10:47:16 +02:00			`####Main`
			`- Allow show/hide animations to animate the height. This way the other modules won't jump around.`
Added alert todos 2016-04-03 20:08:22 +02:00
			`####Alert`
			`- Vertical centering of alerts`
			`- Rewrite the alert module in vanilla JavaScript`
Add todo. 2016-04-01 10:47:16 +02:00
Update todo. 2016-03-31 14:20:43 +02:00			`####Documentation`
			`- Write all the documentation. :)`
Add module info to readme. 2016-03-30 15:20:14 +02:00
Squashed commit of the following: 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 2016-04-03 19:52:13 +02:00			`##Modules`
Added Callmonitor to README 2016-03-30 15:13:46 +02:00
updated readme 2016-03-31 11:08:06 +02:00			`### Default modules:`
Add module subfolder support. 2016-04-01 17:35:29 +02:00			`- [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)`
Added Alert module to README 2016-04-03 13:02:49 +02:00			`- [Alert](modules/default/alert)`
updated readme 2016-03-31 11:08:06 +02:00
			`### 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 ...)`
Added Callmonitor to README 2016-03-30 15:13:46 +02:00
Added MMM-Facial-Recognition to README 2016-03-31 13:37:44 +02:00			`- [MMM-Facial-Recognition by PaViRo](https://github.com/paviro/MMM-Facial-Recognition) <br> Facial recognition and module swapping based on the current user ...`
Add server (web/socket), create socket system, better helper loader. - The Magic Mirror is now hosted via a express server, allowing you to load it from an external client (for debugging.) - It now includes a socket system to communicate between the node_helper and the client module. - node_helpers are now only loaded if the module is configured in the config. 2016-03-30 12:20:46 +02:00
Added MMM-Wunderlist to README 2016-04-01 02:24:06 +02:00			`- [MMM-Wunderlist by PaViRo](https://github.com/paviro/MMM-Wunderlist) <br> Displays your Wunderlist todos on your mirror ...`