diff --git a/README.md b/README.md index c5db8e4a7..039968708 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,9 @@ python scripts/generate_pack.py --platform retroarch --region us --one-per-slot # Firmware only: the game data a list or a core names is left out, each file named python scripts/generate_pack.py --platform emuelec --no-game-data +# The bare minimum: only the files each core needs to start +python scripts/generate_pack.py --platform batocera --required-only + # List available emulators and systems python scripts/generate_pack.py --list-emulators python scripts/generate_pack.py --list-systems @@ -203,4 +206,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-05T10:43:18Z* +*Auto-generated on 2026-11-05T10:52:39Z* diff --git a/scripts/generate_readme.py b/scripts/generate_readme.py index cfaec5afe..132a2eb3a 100644 --- a/scripts/generate_readme.py +++ b/scripts/generate_readme.py @@ -788,6 +788,9 @@ def generate_readme(db: dict, platforms_dir: str, db_path: str = "database.json" "# Firmware only: the game data a list or a core names is left out, each file named", "python scripts/generate_pack.py --platform emuelec --no-game-data", "", + "# The bare minimum: only the files each core needs to start", + "python scripts/generate_pack.py --platform batocera --required-only", + "", "# List available emulators and systems", "python scripts/generate_pack.py --list-emulators", "python scripts/generate_pack.py --list-systems", diff --git a/tests/test_doc_pages.py b/tests/test_doc_pages.py index 0d4510e12..3a246ec4a 100644 --- a/tests/test_doc_pages.py +++ b/tests/test_doc_pages.py @@ -1700,5 +1700,16 @@ class InstallerVariablesAreDocumented(unittest.TestCase): self.assertIn("cache", section[:section.index("\n## ", 1)]) +class ReadmeKeepsItsPointers(unittest.TestCase): + def test_the_bare_minimum_is_built_below(self): + """The README sent a reader to 'build your own pack below' for a bare + minimum, and the block below never named --required-only.""" + readme = (ROOT / "README.md").read_text(encoding="utf-8") + self.assertIn("For a bare minimum, build your own pack below.", readme) + block = readme[readme.index("## Build your own pack"):] + block = block[:block.index("\n## ", 1)] + self.assertIn("--required-only", block) + + if __name__ == "__main__": unittest.main()