makearmy/v2026.04.02
1
0
Fork 0
mirror of https://github.com/Abdess/retrobios.git synced 2026-06-25 20:42:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: add methodology and ground truth narrative to readme and site

Browse source
This commit is contained in:
Abdessamad Derraz 2026-03-25 14:50:09 +01:00
parent 23d76d54fd
commit 593466b655
3 changed files with 63 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

20
scripts/generate_readme.py
View file

@ -97,11 +97,25 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
) if Path("emulators").exists() else 0
lines = [
"# Retrogaming BIOS & Firmware Collection",
"# RetroBIOS",
"",
"Complete, verified collection of BIOS, firmware, and system files for retrogaming emulators.",
"Source-verified BIOS and firmware packs for retrogaming platforms.",
"",
f"> **{total_files}** files | **{size_mb:.1f} MB** | **{len(coverages)}** platforms | **{emulator_count}** emulator profiles",
"Every file in this collection is traced to its ground truth: the emulator's source code.",
"Not .info files, not documentation, not community wikis - the actual code that loads the file.",
f"{emulator_count} emulators profiled from source, {len(coverages)} platforms cross-referenced,",
f"{total_files:,} files verified.",
"",
"### How it works",
"",
"1. **Profile emulators from source code** - read the code, document every file loaded, its hash, size, and validation",
"2. **Cross-reference with platforms** - each platform (RetroArch, Batocera, Recalbox...) declares what it needs",
"3. **Build packs** - for each platform, include the baseline files + what its cores actually require",
"4. **Verify everything** - platform-native verification (MD5, existence) + emulator-level validation (CRC32, SHA256, size)",
"",
"When a platform and an emulator disagree on a file, we detect it. When a better variant exists in the repo, we use it.",
"",
f"> **{total_files:,}** files | **{size_mb:.1f} MB** | **{len(coverages)}** platforms | **{emulator_count}** emulator profiles",
"",
"## Download",
"",