Files
Brandon T. Kowalski ba7a57cd6f docs: parameterize CFW links with single source of truth
Add docs/_includes/cfw-links.md as shared link definitions included
via pymdownx.snippets in all doc pages. README uses markdown
reference-style links defined at the bottom. Update Allium URL to
goweiwen/Allium, Onion to onionui.github.io, TrimUI to github.com/trimui.
2026-03-21 21:59:03 -04:00

2.1 KiB

Quick Start Guide

Get up and running with Grout in five steps.

Before You Begin

Make sure you have:

  • A RomM server running and accessible
  • A compatible device running [Allium][allium], [Batocera][batocera], [Knulli][knulli], [muOS][muos], [NextUI][nextui], [Onion][onion], [ROCKNIX][rocknix], [Spruce v4][spruce], or [TrimUI][trimui]
  • Your device connected to Wi-Fi

Getting Started Checklist

Step 1: Install Grout

Choose your platform:

Step 2: Launch and Select Language

When you first launch Grout, select your preferred language using Left/Right, then press A to confirm.

Step 3: Connect to Your RomM Server

Enter your connection details and authenticate.

See the User Guide for detailed instructions.

Step 4: Map Your Platforms

Tell Grout where to save games for each platform:

  • Skip - Don't download games for this platform
  • Create {Directory} - Let Grout create a new folder
  • /{Existing Directory} - Use an existing folder
  • Custom - Specify a custom path

Press Start when done.

Step 5: Download Your First Game

  1. Select a platform from the main menu
  2. Browse or search for a game
  3. Press A to select and download

That's it! Your game is now on your device.


What's Next?


A small request: Spread Joy!

A significant amount of time has been spent building Grout.

If you enjoy using Grout and feel inclined to pay it forward, go do something nice for someone!

--8<-- "docs/_includes/cfw-links.md"