@@ -16,15 +16,13 @@ installers can be found under:
1616
17171 . Download and install the latest _ Node.js_ version, see the official
1818 documentation:
19-
20- - [ Linux based distributions] ( https://github.com/nodesource/distributions )
21- - [ Others] ( https://nodejs.org/en/download )
22-
19+ - [ Linux based distributions] ( https://github.com/nodesource/distributions )
20+ - [ Others] ( https://nodejs.org/en/download )
23212 . check if ` git ` is installed on your machine by executing ` git ` (should show
2422 usage), otherwise install it
25233 . Clone the repository:
2624 ` git clone https://github.com/MagicMirrorOrg/MagicMirror `
27- 4 . Enter the repository: ` cd MagicMirror/ `
25+ 4 . Enter the repository: ` cd MagicMirror `
28265 . Install the application: ` npm run install-mm `
29276 . Make a copy of the config sample file:
3028 ` cp config/config.js.sample config/config.js `
@@ -74,41 +72,32 @@ team. Use these scripts and methods at your own risk.
7472
7573## Other Operating Systems
7674
77- ### Windows:
78-
79- To get the MagicMirror software running on Windows, you have to do two things in
80- addition to the [ steps] ( #manual-installation ) above:
75+ ### Windows
8176
82- 4a. Install dependencies in the vendor and font directories:
77+ ::: warning IMPORTANT
78+ MagicMirror² is designed to run on Linux. But with an extra step in the
79+ installation process and a different start command, you can also
80+ run it on Windows. Some third-party modules may not work on Windows.
81+ :::
8382
84- Powershell:
83+ To get the software running on Windows, you have to do two things in
84+ addition to the [ steps] ( #manual-installation ) above:
8585
86- 1 . ` cd fonts; npm install; cd .. `
87- 2 . ` cd vendor; npm install; cd .. `
86+ ** After step 5:** Install dependencies in the vendor and font directories:
8887
89- Command Prompt :
88+ Powershell :
9089
91- 1 . ` cd fonts && npm install && cd .. `
92- 2 . ` cd vendor && npm install && cd .. `
90+ 1 . ` cd fonts; npm install; cd .. `
91+ 2 . ` cd vendor; npm install; cd .. `
9392
94- Otherwise the screen will stay black when starting the MagicMirror.
93+ Command Prompt:
9594
96- 5a. Fix the start script in the ` package.json ` file:
95+ 1 . ` cd fonts && npm install && cd .. `
96+ 2 . ` cd vendor && npm install && cd .. `
9797
98- 1 . Navigate to the file ` package.json `
99- 2 . Find where it says
100- ```
101- "start": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js",
102- "start:dev": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js dev",
103- ```
104- 3 . and replace it with
105- ```
106- "start": ".\\node_modules\\.bin\\electron js\\electron.js",
107- "start:dev": ".\\node_modules\\.bin\\electron js\\electron.js dev",
108- ```
98+ Otherwise the screen will stay black when starting the software.
10999
110- Otherwise the program won't start, but will display this error message:
111- ` "'DISPLAY' is not recognized as an internal or external command, operable program or batch file." `
100+ ** Step 7:** In Windows you must use ` npm start:windows ` instead of ` npm start ` .
112101
113102## Usage
114103
@@ -130,7 +119,7 @@ In this case, you can start MagicMirror² in server only mode by manually runnin
130119` npm run server ` . This will start the server, after which you can open the
131120application in your browser of choice. Detailed description below.
132121
133- ::: warning IMPORTANT
122+ ::: warning IMPORTANT
134123Make sure that you whitelist the interface/ip
135124(` ipWhitelist ` ) in the server config where you want the client to connect to,
136125otherwise it will not be allowed to connect to the server. You also need to set
@@ -154,3 +143,7 @@ connect as a standalone client to this instance, to show the MM from the server.
154143Then from your RPi, you run it with:
155144` node clientonly --address 192.168.1.5 --port 8080 ` . (Specify the ip address and
156145port number of the server)
146+
147+ ### Wayland
148+
149+ If you use Wayland. Run ` npm run start:wayland ` instead of ` npm run start ` to start.
0 commit comments