From 90c62837426c4f5035d79715ae6881d2eeef7acf Mon Sep 17 00:00:00 2001 From: Michael Teeuw Date: Tue, 29 Mar 2016 13:35:55 +0200 Subject: [PATCH] Add configuration instructions and todo. --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 33bc3757..498717ec 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,23 @@ # 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. Install [Node.js](https://nodejs.org/en/) 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. -###Helper scripts +####Loader +- Loading of module uses `eval()`. We might want to look into a better solution. [loader.js#L112](https://github.com/MichMich/MagicMirror/blob/v2-beta/js/loader.js#L112). + +####Helper scripts - Only start helper scripts of modules that are actually loaded in the UI (config.js) - Notification system, so that not every helper scripts needs it's own socket to the UI. -#WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH. +