kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 19:53:36 +00:00
Code Issues Projects Releases Wiki Activity

Updated Home (markdown)

Kristjan ESPERANTO 2023-10-29 22:04:47 +01:00
parent 690a724973
commit a79f7ceda1
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Home.md

@ -1,6 +1,7 @@
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. http://magicmirror.builders
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. https://magicmirror.builders/
## Default modules
The following modules are installed by default.
- [**Alert**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/alert)
- [**Calendar**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/calendar)
@ -12,17 +13,18 @@ The following modules are installed by default.
- [**Weather Forecast**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/weatherforecast)
## Optional Modules
[List of 3rd Party Modules](3rd-party-modules)
## Installing a module
To install 3rd party or your own custom modules just follow these steps:
- Navigate to the modules folder via the following command: `cd ~/MagicMirror/modules`.
- Clone the module from github: `git clone https://github.com/author/module-name` (remembering to replace the URL with that of the module on github).
- Clone the module from GitHub: `git clone https://github.com/author/module-name` (remembering to replace the URL with that of the module on github).
- Follow any additional instruction on from the modules readme.
- Add your brand new module to your config! This is the file `config/config.js` that you duplicated earlier. Edit this in your favourite editor and add:
```
```js
{
module: 'module name',
position: 'position',
@ -32,4 +34,5 @@ To install 3rd party or your own custom modules just follow these steps:
}
},
```
to the list of modules. You can look at the default modules for examples and further details can be found on the main readme.