kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 11:50:00 +00:00
Code Issues Projects Releases Wiki Activity
MagicMirror/README.md
Michael Teeuw c1bd469086 updated readme
2016-03-31 11:08:06 +02:00

1.1 KiB
Raw Blame History

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, 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. Install Node.js
  2. Execute npm install && npm start.

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

####Loader

  • Loading of module uses eval(). We might want to look into a better solution. loader.js#L112.

##Modules

Default modules:

  • Clock
  • Calendar
  • Current Weather
  • Weather Forecast
  • News Feed
  • Compliments
  • Hello World

3rd Party Modules: