docs: name the cards the interface finds

The interface finds a muOS, Onion, spruceOS, MinUI, KNULLI or ROCKNIX card by itself (card_platform and the card rules in install.py) and lists it as a setup. The FAQ says so where it fills an SD card, within its word ceiling.
This commit is contained in:
Abdessamad Derraz committed 2026-10-23 21:39:42 +02:00
1 parent b88f23947a
commit c35ae29d53
2 files changed
+26 -10

No files matched your search

+17 -1
View File
@@ -161,13 +161,29 @@ class FaqInstallsFromWhatYouHold(unittest.TestCase):
def test_no_unzip_before_from_pack(self):
section = " ".join(self._section("No internet on the device?").split())
self.assertIn("point `--from-pack` at your ZIP, still zipped", section)
self.assertIn("point `--from-pack` at your ZIP:", section)
self.assertNotIn("unzip", section)
install = (REPO_ROOT / "install.py").read_text(encoding="utf-8")
self.assertIn("Install from a pack already downloaded: its ZIP, one of its parts",
(REPO_ROOT / "wiki" / "installer.md").read_text(encoding="utf-8"))
self.assertIn('"--from-pack"', install)
def test_the_cards_the_interface_finds(self):
"""Each system the SD card answer names is one install.py tells by
its card: a release file (_CARD_RULES) or a card rule."""
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)
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"):
with self.subTest(card=name):
self.assertIn(name, known)
source = (REPO_ROOT / "install.py").read_text(encoding="utf-8")
self.assertIn('f"{card[2]} SD card ({_mount_name(mount)})"', source)
def test_a_wiped_card_links_the_copy(self):
section = self._section("Lost or wiped card?")
self.assertIn("`--from`", section)
+9 -9
View File
@@ -16,7 +16,7 @@ terms: ios, iphone, ipad
## How do I know which BIOS I need?
Add `--dry-run`. It lists the files, changing nothing.
`--dry-run` lists them and changes nothing.
<!-- os-tabs -->
```sh
@@ -25,7 +25,7 @@ curl -fsSL https://raw.githubusercontent.com/Abdess/retrobios/main/install.sh |
## Do I need every file of a console?
No. To keep only your region's BIOS, add it, like `--region us`.
No. `--region us` keeps only your region's BIOS.
## Does the BIOS set the game's language?
@@ -49,8 +49,8 @@ Game sets must match the emulator's version:
## Keys, firmware or BIOS?
- **BIOS** or **firmware**: the console's own program, like `scph5501.bin`.
- Newer consoles need a system update, like `PS3UPDAT.PUP`, installed from the
emulator's menu.
- Newer consoles need a system update, like `PS3UPDAT.PUP`, installed in the
emulator.
- **Keys** unlock encrypted games, like `prod.keys` for Switch.
## Is the command safe? { #is-piping-the-installer-into-a-shell-safe }
@@ -67,7 +67,7 @@ Read them first: [install.sh](https://github.com/Abdess/retrobios/blob/main/inst
## Windows or my antivirus blocks the command
Use your setup's ZIP, if it has one: [Get your files](../which-pack.md).
Use your setup's ZIP, if any: [Get your files](../which-pack.md).
## Why is there no ZIP for my setup?
@@ -76,7 +76,8 @@ setup's files and checks each one. `--dry-run` shows the list first.
## Fill an SD card from a computer?
Name your setup and the card's BIOS folder. For RetroArch on a Switch,
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,
with the card in drive `E:`, run:
<!-- os-tabs windows: --platform retroarch --dest E:\retroarch\cores\system -->
@@ -87,8 +88,7 @@ curl -fsSL https://raw.githubusercontent.com/Abdess/retrobios/main/install.sh \
## No internet on the device?
Fill its folder from a computer, as above, or point `--from-pack` at
your ZIP, still zipped: [Without a network](installer.md#without-a-network-offline-install).
Fill it from a computer, as above, or point `--from-pack` at your ZIP: [Without a network](installer.md#without-a-network-offline-install).
## Lost or wiped card?
@@ -116,7 +116,7 @@ Yes: [PCSX2](https://pcsx2.net/docs/setup/bios/) for PlayStation 2,
## Is this legal?
Laws differ by country. [Is it legal?](legal.md)
[It depends on your country](legal.md).
## Next steps