Installation Guide for Spruce / SprigUI / TwigUI
This guide will help you install Grout on devices running Spruce v4, SprigUI, or TwigUI.
[!NOTE] SprigUI and TwigUI are alternative operating systems developed by the Spruce team. All three are fully supported by the same Grout package for Spruce.
Tested Devices
Grout has been tested on the following devices running Spruce:
| Manufacturer | Device |
|---|---|
| Miyoo | A30 |
| Miyoo | Flip |
| Miyoo | Mini Flip |
| TrimUI | Brick |
| TrimUI | Smart Pro |
| GKD | Pixel 2 |
Prerequisites
- Miyoo device with Spruce (v4/nightlies) installed on an SD card
- Device connected to a Wi-Fi network
Installation Steps
Manual Installation
- Download the latest Grout release for Spruce.
- Unzip the downloaded archive.
- Place the
Groutdirectory intoSD_ROOT/App/. - Launch Grout from the
Appmenu and enjoy!
Update
In-App update (Recommended)
Grout has a built-in update mechanism. To update Grout, launch the application and navigate to the Settings menu. From there,
select Check for Updates. If a new version is available, follow the on-screen prompts to download and install the update.
Manual update
To update Grout, simply download the latest release and replace the existing Grout folder in your SD_ROOT/App/ directory. If you
have made any custom configurations, ensure to back them up before replacing the folder. Be sure to keep the grout/config.json
file if you do not want to authenticate again, and configure platforms folder mappings again.
Next Steps
After installation is complete, check out the User Guide to learn how to use Grout.