Skip to content

Commit 04ef4e7

Browse files
BrandonKowalskiBrandonKowalski
committed
docs: add MinUI install guide and opt into Node.js 24 for CI
Add install-minui.md with tested devices, installation steps, and update instructions. Add MinUI to mkdocs nav and cfw-links. Set FORCE_JAVASCRIPT_ACTIONS_TO_NODE24 on both workflows ahead of the June 2026 deprecation of Node.js 20 runners.
1 parent 739604d commit 04ef4e7

9 files changed

Lines changed: 70 additions & 10 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ on:
1212
- pyproject.toml
1313
- uv.lock
1414

15+
env:
16+
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
17+
1518
permissions:
1619
contents: read
1720
pages: write

‎.github/workflows/release.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ on:
2020
permissions:
2121
contents: write
2222

23+
env:
24+
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
25+
2326
jobs:
2427
prepare:
2528
runs-on: ubuntu-22.04-arm

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
A RomM Client for your retro doo-dad.
1010
</h3>
1111

12-
[Allium][allium] · [Batocera][batocera] · [Knulli][knulli] · [muOS][muos] · [NextUI][nextui] · [Onion][onion] · [ROCKNIX][rocknix] · [Spruce][spruce] · [TrimUI][trimui]
12+
[Allium][allium] · [Batocera][batocera] · [Knulli][knulli] · [MinUI][minui] · [muOS][muos] · [NextUI][nextui] · [Onion][onion] · [ROCKNIX][rocknix] · [Spruce][spruce] · [TrimUI][trimui]
1313

1414
<br>
1515

@@ -99,6 +99,7 @@ If you enjoy using Grout and feel inclined to pay it forward, go do something ni
9999
[allium]: https://github.com/goweiwen/Allium
100100
[batocera]: https://batocera.org
101101
[knulli]: https://knulli.org
102+
[minui]: https://github.com/shauninman/MinUI
102103
[muos]: https://muos.dev
103104
[nextui]: https://nextui.loveretro.games
104105
[onion]: https://onionui.github.io

‎docs/_includes/cfw-links.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[allium]: https://github.com/goweiwen/Allium
22
[batocera]: https://batocera.org
33
[knulli]: https://knulli.org
4+
[minui]: https://github.com/shauninman/MinUI
45
[muos]: https://muos.dev
56
[nextui]: https://nextui.loveretro.games
67
[onion]: https://onionui.github.io

‎docs/getting-started/install-minui.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Installation Guide for MinUI
2+
3+
This guide will help you install Grout on devices running [MinUI][minui].
4+
5+
## Tested Devices
6+
7+
Grout has been tested on the following devices running MinUI:
8+
9+
| Manufacturer | Device |
10+
|--------------|---------------|
11+
| Miyoo | A30 |
12+
| Miyoo | Mini Plus |
13+
14+
_Please help verify compatibility on other devices by reporting your results!_
15+
16+
## Prerequisites
17+
18+
- Device with MinUI installed on an SD card
19+
- Device connected to a Wi-Fi network
20+
21+
## Installation Steps
22+
23+
1. Download the latest Grout release for MinUI from the [releases page](https://github.com/rommapp/grout/releases/latest).
24+
2. Unzip the downloaded archive.
25+
3. Place the `Grout` directory into `SD_ROOT/Tools/` on your SD card.
26+
4. Launch Grout from the Tools menu and enjoy!
27+
28+
!!! note
29+
The MinUI distribution includes both ARM32 and ARM64 binaries. The correct one is selected automatically based on your device.
30+
31+
## Update
32+
33+
### In-App update (Recommended)
34+
35+
Grout has a built-in update mechanism. To update Grout, launch the application and navigate to the `Settings` menu. From there,
36+
select `Check for Updates`. If a new version is available, follow the on-screen prompts to download and install the update.
37+
38+
### Manual update
39+
40+
To update Grout, simply download the latest release and replace the existing `Grout` folder in `SD_ROOT/Tools/`. If you
41+
have made any custom configurations, ensure to back them up before replacing the folder. Be sure to keep the `config.json`
42+
file if you do not want to authenticate again, and configure platforms folder mappings again.
43+
44+
## Next Steps
45+
46+
After installation is complete, check out the [User Guide](../usage/guide.md) to learn how to use Grout.
47+
48+
--8<-- "docs/_includes/cfw-links.md"

‎docs/getting-started/install-rocknix.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Grout has been tested on the following devices running ROCKNIX:
1111
| Anbernic | RG34XX |
1212
| Anbernic | RG35XXSP |
1313
| Anbernic | RG DS |
14-
| Retroid | Flip 2 |
1514
| Powkiddy | RGB30 |
1615
| Powkiddy | X55 |
16+
| Retroid | Flip 2 |
1717

1818
_Please help verify compatibility on other devices by reporting your results!_
1919

‎docs/getting-started/install-spruce.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ This guide will help you install Grout on devices running [Spruce][spruce] v4.
66

77
Grout has been tested on the following devices running Spruce:
88

9-
| Manufacturer | Device | Compatibility |
10-
|--------------|-----------|---------------|
11-
| TrimUI | Brick | Yes |
12-
| TrimUI | Smart Pro | Yes |
13-
| Miyoo | Flip V2 | Yes |
14-
| Miyoo | Mini Flip | Yes |
15-
| Miyoo | A30 | Yes |
9+
| Manufacturer | Device |
10+
|--------------|-----------|
11+
| Miyoo | A30 |
12+
| Miyoo | Flip |
13+
| Miyoo | Mini Flip |
14+
| TrimUI | Brick |
15+
| TrimUI | Smart Pro |
1616

1717
## Prerequisites
1818

‎docs/platforms/minui.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# MinUI Platform Mappings
1+
# MinUI
2+
3+
## Platform Mappings
24

35
This table shows the mappings of RomM Fs Slug to MinUI's platform folders.
46

‎mkdocs.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ nav:
6969
- Allium: getting-started/install-allium.md
7070
- Batocera: getting-started/install-batocera.md
7171
- Knulli: getting-started/install-knulli.md
72+
- MinUI: getting-started/install-minui.md
7273
- muOS: getting-started/install-muos.md
7374
- NextUI: getting-started/install-nextui.md
7475
- Onion: getting-started/install-onion.md
@@ -83,6 +84,7 @@ nav:
8384
- Allium: platforms/allium.md
8485
- Batocera: platforms/BATOCERA.md
8586
- Knulli: platforms/knulli.md
87+
- MinUI: platforms/minui.md
8688
- muOS: platforms/muos.md
8789
- NextUI: platforms/nextui.md
8890
- Onion: platforms/onion.md

0 commit comments

Comments
 (0)