mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-27 11:50:00 +00:00
Add link to documentation website
parent
5dc51ba864
commit
938daa9b57
4
Home.md
4
Home.md
@ -1,5 +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. https://magicmirror.builders/
|
||||
|
||||
Check the [documentation website](https://docs.magicmirror.builders/) to find out how to get started.
|
||||
|
||||
## Default modules
|
||||
|
||||
The following modules are installed by default.
|
||||
@ -20,7 +22,7 @@ The following modules are installed by default.
|
||||
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).
|
||||
- Follow any additional instruction on from the modules readme.
|
||||
- Follow any additional instructions in the module 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
|
||||
|
Loading…
x
Reference in New Issue
Block a user