diff --git a/scripts/packreadme.py b/scripts/packreadme.py index b64c1c6c..40da81eb 100644 --- a/scripts/packreadme.py +++ b/scripts/packreadme.py @@ -163,7 +163,7 @@ def _build_readme( "romm": ( "INSTALLATION GUIDE (RomM server)\n\n" " 1. Locate your RomM library folder\n" - " 2. Navigate to the bios/ subdirectory\n" + " 2. Navigate to its bios/ folder (library/bios/)\n" " 3. Extract all files from this archive directly into that folder\n" " 4. Restart the RomM service to detect new files\n\n" ), @@ -185,8 +185,20 @@ def _build_readme( ), } - # Lakka uses same guide as RetroArch - guides["lakka"] = guides["retroarch"] + guides["lakka"] = ( + "INSTALLATION GUIDE (Lakka)\n\n" + " Lakka reads its BIOS files from /storage/system/.\n\n" + " Option A: Via network share\n" + " --------------------------\n" + " 1. On Lakka: Settings > Services > Samba Enable\n" + " 2. On your PC, open the System share: \\\\LAKKA\\System\\\n" + " (macOS and Linux: smb://lakka/System)\n" + " 3. Extract all files from this archive directly into that share\n\n" + " Option B: Via SSH\n" + " -----------------\n" + " 1. On Lakka: Settings > Services > SSH Enable\n" + " 2. Copy the files to /storage/system/ (scp -r * root@lakka:/storage/system/)\n\n" + ) # A platform without a written guide is told where its files go by the # registry, which the installer reads too: "your BIOS directory" sent diff --git a/tests/test_audit_regressions.py b/tests/test_audit_regressions.py index 7ed3470a..51019a37 100644 --- a/tests/test_audit_regressions.py +++ b/tests/test_audit_regressions.py @@ -3284,5 +3284,25 @@ class TheSiteCountsSlotsNotVersions(unittest.TestCase): self.assertIn("1 in repo, 1 missing", line) + +class EveryReadmeNamesItsFolder(unittest.TestCase): + """The Lakka pack's README reused RetroArch's guide and never named + /storage/system, the folder the registry and the installer use.""" + + def test_the_registry_folder_is_in_the_guide(self): + from scripts.packreadme import _build_readme + + registry = yaml.safe_load((ROOT / "platforms" / "_registry.yml").read_text()) + for name, entry in registry["platforms"].items(): + folder = (entry.get("extract_to") or "").rstrip("/") + if not folder: + continue + with self.subTest(platform=name): + text = _build_readme(name, name, "", 1, 1, bios_paths=[folder]) + self.assertIn(folder, text) + lakka = _build_readme("lakka", "Lakka", "", 1, 1) + self.assertNotIn("retroarch/system", lakka) + + if __name__ == "__main__": unittest.main()