mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-11 05:53:23 -05:00
docs: state only what the data supports
This commit is contained in:
1 parent
4c5ca17682
commit
b00ca4d237
3 files changed
+31
-26
No files matched your search
@@ -318,15 +318,19 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
|
||||
"## What's included",
|
||||
"",
|
||||
"BIOS, firmware, and system files for consoles from Atari to PlayStation 3.",
|
||||
"These are the files an emulator needs but cannot ship itself.",
|
||||
"These are the files an emulator loads from disk instead of"
|
||||
" carrying inside itself. Some are required to boot a system,"
|
||||
" others improve accuracy or unlock a feature; the packs carry"
|
||||
" both.",
|
||||
"",
|
||||
"Each one is checked the way your platform checks it. Most compare"
|
||||
" a checksum, the fingerprint of a file's contents, so a corrupt or"
|
||||
" wrong-region copy is caught. RetroArch, Lakka and RetroPie only"
|
||||
"Each file is checked the way your platform checks it. Most compare"
|
||||
" a checksum, the fingerprint of a file's contents, which catches a"
|
||||
" corrupt or unexpected copy. RetroArch, Lakka and RetroPie only"
|
||||
" look for the filename, because that is all their code does: the"
|
||||
" Coverage table says which applies to you. Whatever your platform"
|
||||
" checks, the collection stores four fingerprints per file, and the"
|
||||
" expected values come from the emulator's own source code.",
|
||||
" Coverage table says which applies to you. Independently of that,"
|
||||
" the collection records five fingerprints per file, and wherever"
|
||||
" an emulator's code states an expected size or hash, that value is"
|
||||
" read from its source and rechecked here.",
|
||||
"",
|
||||
(
|
||||
f"- **{missing_total} files** the platforms' emulators load are"
|
||||
@@ -338,8 +342,8 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
|
||||
),
|
||||
f"- **{len(coverages)} platforms** supported with platform-specific verification",
|
||||
f"- **{emulator_count} emulators** profiled from source (RetroArch cores + standalone)",
|
||||
f"- **{len(system_ids)} systems** covered (NES, SNES, PlayStation, Saturn, Dreamcast, ...)",
|
||||
f"- **{total_files:,} files**, each with its SHA1, MD5, SHA256 and CRC32 fingerprints:"
|
||||
f"- **{len(system_ids)} systems** handled by those emulators (NES, SNES, PlayStation, Saturn, Dreamcast, ...)",
|
||||
f"- **{total_files:,} files**, each with its SHA1, MD5, SHA256, CRC32 and Adler-32 fingerprints:"
|
||||
f" {comp['systems']['files']:,} system files,"
|
||||
f" {comp['arcade']['files']:,} arcade ROM sets,"
|
||||
f" {comp['game_data']['files']:,} game and engine data files",
|
||||
|
||||
+11
-10
@@ -409,8 +409,8 @@ def generate_home(
|
||||
[
|
||||
"## Platforms",
|
||||
"",
|
||||
"| | Platform | Files | Verification | Download |",
|
||||
"|---|----------|-------|-------------|----------|",
|
||||
"| | Platform | Files | Checked by | Download |",
|
||||
"|---|----------|-------|-----------|----------|",
|
||||
]
|
||||
)
|
||||
|
||||
@@ -433,9 +433,10 @@ def generate_home(
|
||||
lines.extend(
|
||||
[
|
||||
"",
|
||||
"Verification is the check each platform runs itself, replicated "
|
||||
"from its source code. RetroArch only tests that files exist; "
|
||||
"Batocera compares MD5 checksums. "
|
||||
"Checked by is the test each platform runs on its own, replicated "
|
||||
"from its source code. RetroArch only looks for the filename; "
|
||||
"Batocera compares MD5 checksums, the fingerprint of a file's "
|
||||
"contents. "
|
||||
"[How each mode works](wiki/verification-modes.md).",
|
||||
]
|
||||
)
|
||||
@@ -582,8 +583,8 @@ def generate_platform_index(coverages: dict, registry: dict | None = None) -> st
|
||||
f"{len(coverages)} supported platforms with "
|
||||
f"{total_present:,} verified files.",
|
||||
"",
|
||||
"| Platform | Files | Verification | Status | Download |",
|
||||
"|----------|-------|-------------|--------|----------|",
|
||||
"| Platform | Files | Checked by | Status | Download |",
|
||||
"|----------|-------|-----------|--------|----------|",
|
||||
]
|
||||
|
||||
mode_labels = {
|
||||
@@ -616,7 +617,7 @@ def generate_platform_index(coverages: dict, registry: dict | None = None) -> st
|
||||
lines.extend(
|
||||
[
|
||||
"",
|
||||
"Verification is the check each platform runs itself, replicated "
|
||||
"Checked by is the test each platform runs on its own, replicated "
|
||||
"from its source code. "
|
||||
"[How each mode works](../wiki/verification-modes.md).",
|
||||
]
|
||||
@@ -708,7 +709,7 @@ def generate_platform_page(
|
||||
'<div class="rb-stat" markdown>',
|
||||
f'<span class="rb-stat-value">'
|
||||
f'<span class="rb-badge {mode_badge}">{mode}</span></span>',
|
||||
'<span class="rb-stat-label">Verification</span>',
|
||||
'<span class="rb-stat-label">Checked by</span>',
|
||||
"</div>",
|
||||
"",
|
||||
"</div>",
|
||||
@@ -1364,7 +1365,7 @@ def generate_emulator_page(
|
||||
("resources_directory", "Resources directory"),
|
||||
("rom_path", "ROM path"),
|
||||
("game_count", "Game count"),
|
||||
("verification", "Verification mode"),
|
||||
("verification", "Checked by"),
|
||||
("source_ref", "Source ref"),
|
||||
("analysis_date", "Analysis date"),
|
||||
("analysis_commit", "Analysis commit"),
|
||||
|
||||
Reference in new issue
Block a user