Skip to content

Commit

Permalink
Merge branch 'master' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
@khassel
khassel committed Jul 11, 2024
2 parents 61f70b7 + 25ae68c commit 89b6259
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 16 deletions.
5 changes: 1 addition & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@ title: Introduction
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
</a>
<img src="https://img.shields.io/github/actions/workflow/status/magicmirrororg/magicmirror/automated-tests.yaml" alt="GitHub Actions">
<img src="https://img.shields.io/github/checks-status/magicmirrororg/magicmirror/master" alt="Build Status">
<a href="https://codecov.io/gh/MagicMirrorOrg/MagicMirror">
<img src="https://img.shields.io/codecov/c/github/magicmirrororg/MagicMirror?token=LEG1KitZR6" alt="CodeCov Status"/>
</a>
<img src="https://img.shields.io/github/check-runs/magicmirrororg/magicmirror/master" alt="Build Status">
<a href="https://github.com/MagicMirrorOrg/MagicMirror">
<img src="https://img.shields.io/github/stars/magicmirrororg/magicmirror?style=social">
</a>
Expand Down
14 changes: 8 additions & 6 deletions getting-started/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,16 @@ installers can be found under:
- [Linux based distributions](https://github.com/nodesource/distributions)
- [Others](https://nodejs.org/en/download)

2. Clone the repository and check out the master branch:
2. check if `git` is installed on your machine by executing `git`
(should show usage), otherwise install it
3. Clone the repository:
`git clone https://github.com/MagicMirrorOrg/MagicMirror`
3. Enter the repository: `cd MagicMirror/`
4. Install the application: `npm run install-mm`
5. Make a copy of the config sample file:
4. Enter the repository: `cd MagicMirror/`
5. Install the application: `npm run install-mm`
6. Make a copy of the config sample file:
`cp config/config.js.sample config/config.js`
6. Start the application: `npm run start` \
For **Server Only** use: `npm run server` .
7. Start the application: `npm run start` \
For **Server Only** use: `npm run server`

::: warning NOTE
The installation step for `npm run install-mm` will take a very
Expand Down
9 changes: 4 additions & 5 deletions getting-started/requirements.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ various different types of hardware, but new versions will only be tested on a
Raspberry Pi.

_Electron_, the app wrapper around MagicMirror², only supports the Raspberry Pi
2, 3 & 4. The Raspberry Pi 0/1 is currently **not** supported. If you want to
2, 3, 4 & 5. The Raspberry Pi 0/1 is currently **not** supported. If you want to
run this on a Raspberry Pi 1, use the [server only](installation.md#server-only)
feature and setup a fullscreen browser yourself. (Yes, people have managed to
run MM² also on a Pi0, so if you insist, search in the forums.)
Expand All @@ -25,12 +25,11 @@ If you want to run the software on other Operating Systems, take a look at

Using a Lite Version of Raspberry Pi OS **will not work**.

Raspberry Pi OS versions based on Debian "Stretch" are also no longer supported.
Raspberry Pi OS versions based on Debian "Buster" are also no longer supported.
:::

## Node

::: warning NOTE Node 18 is required!
All older versions (Node 16 and below) have reached end of life and will not
work.
::: warning NOTE Node v20.9.0 or above is required!
All older versions will not work.
:::
2 changes: 1 addition & 1 deletion modules/weather.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The following properties can be configured:

| Option | Description |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tableClass` | The class for the forecast table. <br><br> **Default value:** `'small'` |
| `tableClass` | The class for the forecast table. <br><br>**Possible values:** `'xsmall'`, `'small'`, `'medium'`, `'large'`, `'xlarge'` <br> **Default value:** `'small'` |
| `colored` | If set to `true`, the min and max temperature are color coded. <br><br> **Default value:** `false` |
| `fade` | Fade the future events to black. (Gradient) <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true` |
| `fadePoint` | Where to start fade? <br><br> **Possible values:** `0` (top of the list) - `1` (bottom of list) <br> **Default value:** `0.25` |
Expand Down

0 comments on commit 89b6259

Please sign in to comment.