docs: name MiSTer among the cards found by itself

install.py tells a MiSTer card by its MiSTer binary and menu.rbf since
73b82375d. installer.md said so, the FAQ and the README did not, and sent a
MiSTer user to --dest the card's root, where nothing reads the files.
This commit is contained in:
Abdessamad Derraz committed 2026-11-06 04:09:07 +01:00
1 parent 302f2a1df9
commit 0aa5dd8487
4 files changed
+16 -8

No files matched your search

+2 -2
View File
@@ -27,7 +27,7 @@ irm https://abdess.github.io/retrobios/i.ps1 | iex
# Android (Termux: it installs Python and asks for storage access)
curl -fsSL https://abdess.github.io/retrobios/i | sh
# SD card mounted on a PC: a muOS, KNULLI, ROCKNIX, Onion, spruceOS or MinUI card
# SD card mounted on a PC: a muOS, KNULLI, ROCKNIX, MiSTer, Onion, spruceOS or MinUI card
# is found by itself. For another card, --dest is its BIOS folder
# (RetroArch on Switch: retroarch/cores/system, on Android: RetroArch/system)
curl -fsSL https://abdess.github.io/retrobios/i | sh -s -- --platform retroarch --dest /path/to/sdcard/retroarch/cores/system
@@ -208,4 +208,4 @@ The scripts and tooling are released under the [MIT License](LICENSE).
The BIOS and firmware files are not covered by that license: they are third-party system software, preserved and provided for personal backup, archival, and interoperability with emulation software. [NOTICE](NOTICE) sets out their status and how to ask for a file to be removed.
The reasoning, and where it is weakest, is in [the project's legal position](https://abdess.github.io/retrobios/wiki/legal/).
*Auto-generated on 2026-11-06T02:20:28Z*
*Auto-generated on 2026-11-06T03:08:31Z*
+1 -1
View File
@@ -579,7 +579,7 @@ def generate_readme(db: dict, platforms_dir: str, db_path: str = "database.json"
"# Android (Termux: it installs Python and asks for storage access)",
install_command("sh"),
"",
"# SD card mounted on a PC: a muOS, KNULLI, ROCKNIX, Onion, spruceOS or MinUI card",
"# SD card mounted on a PC: a muOS, KNULLI, ROCKNIX, MiSTer, Onion, spruceOS or MinUI card",
"# is found by itself. For another card, --dest is its BIOS folder",
"# (RetroArch on Switch: retroarch/cores/system, on Android: RetroArch/system)",
install_command("sh", "--platform retroarch --dest /path/to/sdcard/retroarch/cores/system"),
+11 -3
View File
@@ -206,13 +206,21 @@ class FaqInstallsFromWhatYouHold(unittest.TestCase):
import install # noqa: PLC0415
section = " ".join(self._section("Fill an SD card from a computer?").split())
self.assertIn("The interface finds a muOS, Onion, spruceOS, MinUI, KNULLI or ROCKNIX "
"card by itself.", section)
self.assertIn("The interface finds a muOS, Onion, spruceOS, MinUI, KNULLI, ROCKNIX or "
"MiSTer card by itself.", section)
known = {rule.name for rule in install._card_rules()}
known |= {install.display_name(name) for name, _marker, _prefix in install._CARD_RULES}
for name in ("muOS", "Onion", "spruceOS", "MinUI", "KNULLI", "ROCKNIX"):
for name in ("muOS", "Onion", "spruceOS", "MinUI", "KNULLI", "ROCKNIX", "MiSTer FPGA"):
with self.subTest(card=name):
self.assertIn(name, known)
# A card told by a rule of its share (MiSTer since 73b82375d) is named
# here and in the README, or its user passes --dest the card's root.
readme = (REPO_ROOT / "README.md").read_text(encoding="utf-8")
for rule in install._SHARE_RULES:
word = rule.name.split()[0]
with self.subTest(share=rule.name):
self.assertIn(word, section)
self.assertRegex(readme, rf"# SD card mounted on a PC: .*\b{word}\b")
# The label the first screen gives a card found: "Onion SD card".
self.assertEqual(install._card_word(("retroarch", Path("/x/BIOS"), "Onion")), "SD card")
self.assertEqual(install._card_word(("batocera", Path("/x/bios"), "Batocera")),
+2 -2
View File
@@ -77,8 +77,8 @@ setup's files and checks each one. `--dry-run` shows the list first.
## Fill an SD card from a computer?
The interface finds a muOS, Onion, spruceOS, MinUI, KNULLI or ROCKNIX card by
itself. Name your setup and the card's BIOS folder. For RetroArch on a Switch,
The interface finds a muOS, Onion, spruceOS, MinUI, KNULLI, ROCKNIX or MiSTer
card by itself. For another card, name your setup and the card's BIOS folder. For RetroArch on a Switch,
with the card in drive `E:`, run:
<!-- os-tabs windows: --platform retroarch --dest E:\retroarch\cores\system -->