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

25 lines
800 B
Markdown
Raw Normal View History

feat: slim readme + ci site deployment README: 11141 -> 43 lines. Details on the MkDocs site. generate_readme.py: 444 -> 164 lines. Slim coverage table only. build.yml: adds mkdocs-material install, generate_site.py, gh-deploy. Adds pages: write permission for GitHub Pages deployment.
2026-03-18 10:44:13 +01:00
# Contributing to RetroBIOS
v2: automated BIOS platform with full pipeline Reorganized 6 branches into bios/Manufacturer/Console/. Scrapers for RetroArch, Batocera, Recalbox, and libretro core-info. Platform-aware verification replicating native logic per platform. Pack generation with dedup, alias resolution, variant support. CI/CD: weekly auto-scrape, auto-release, PR validation. Large files (>50MB) stored as GitHub Release assets, auto-fetched at build time.
2026-03-17 10:54:39 +01:00
feat: add archive_prefix for core-specific BIOS subdirectories Closes #43 FBNeo and Kronos expect BIOS archives in core-specific subdirectories (system/fbneo/, system/kronos/). RetroArch firmware check uses .info paths which include these prefixes, so files at root show as Missing. Add archive_prefix field to emulator profiles. The pack code now places archive copies in the prefixed subdirectory while keeping root copies for cores that expect them there (e.g. Geolith for neogeo.zip).
2026-03-31 09:17:54 +02:00
## Add a BIOS file
v2: automated BIOS platform with full pipeline Reorganized 6 branches into bios/Manufacturer/Console/. Scrapers for RetroArch, Batocera, Recalbox, and libretro core-info. Platform-aware verification replicating native logic per platform. Pack generation with dedup, alias resolution, variant support. CI/CD: weekly auto-scrape, auto-release, PR validation. Large files (>50MB) stored as GitHub Release assets, auto-fetched at build time.
2026-03-17 10:54:39 +01:00
feat: add archive_prefix for core-specific BIOS subdirectories Closes #43 FBNeo and Kronos expect BIOS archives in core-specific subdirectories (system/fbneo/, system/kronos/). RetroArch firmware check uses .info paths which include these prefixes, so files at root show as Missing. Add archive_prefix field to emulator profiles. The pack code now places archive copies in the prefixed subdirectory while keeping root copies for cores that expect them there (e.g. Geolith for neogeo.zip).
2026-03-31 09:17:54 +02:00
1. Fork this repository
2. Place the file in `bios/Manufacturer/Console/filename`
3. Variants (alternate hashes): `bios/Manufacturer/Console/.variants/`
4. Create a Pull Request - checksums are verified automatically
v2: automated BIOS platform with full pipeline Reorganized 6 branches into bios/Manufacturer/Console/. Scrapers for RetroArch, Batocera, Recalbox, and libretro core-info. Platform-aware verification replicating native logic per platform. Pack generation with dedup, alias resolution, variant support. CI/CD: weekly auto-scrape, auto-release, PR validation. Large files (>50MB) stored as GitHub Release assets, auto-fetched at build time.
2026-03-17 10:54:39 +01:00
Add platform contribution steps and nav Add an "Add a new platform" section to CONTRIBUTING.md (instructions to write a scraper in scripts/scraper/, create platform YAML in platforms/, register in platforms/_registry.yml, and submit a PR) and note contributor crediting. Update README: bump verified files from 7,296 to 7,302, add RomM and RetroDECK contributor credits with PR links, and refresh the auto-generated timestamp. Add sdlpal to the mkdocs.yml navigation.
2026-04-02 15:36:27 +02:00
## Add a new platform
1. Write a scraper in `scripts/scraper/`
2. Create the platform YAML in `platforms/`
3. Register in `platforms/_registry.yml`
4. Submit a Pull Request
Contributors who add platform support are credited in the README,
on the documentation site, and in the BIOS packs.
feat: add archive_prefix for core-specific BIOS subdirectories Closes #43 FBNeo and Kronos expect BIOS archives in core-specific subdirectories (system/fbneo/, system/kronos/). RetroArch firmware check uses .info paths which include these prefixes, so files at root show as Missing. Add archive_prefix field to emulator profiles. The pack code now places archive copies in the prefixed subdirectory while keeping root copies for cores that expect them there (e.g. Geolith for neogeo.zip).
2026-03-31 09:17:54 +02:00
## File conventions
v2: automated BIOS platform with full pipeline Reorganized 6 branches into bios/Manufacturer/Console/. Scrapers for RetroArch, Batocera, Recalbox, and libretro core-info. Platform-aware verification replicating native logic per platform. Pack generation with dedup, alias resolution, variant support. CI/CD: weekly auto-scrape, auto-release, PR validation. Large files (>50MB) stored as GitHub Release assets, auto-fetched at build time.
2026-03-17 10:54:39 +01:00
feat: add archive_prefix for core-specific BIOS subdirectories Closes #43 FBNeo and Kronos expect BIOS archives in core-specific subdirectories (system/fbneo/, system/kronos/). RetroArch firmware check uses .info paths which include these prefixes, so files at root show as Missing. Add archive_prefix field to emulator profiles. The pack code now places archive copies in the prefixed subdirectory while keeping root copies for cores that expect them there (e.g. Geolith for neogeo.zip).
2026-03-31 09:17:54 +02:00
- Files >50 MB go in GitHub release assets (`large-files` release)
- RPG Maker and ScummVM directories are excluded from deduplication
- See the [documentation site](https://abdess.github.io/retrobios/) for full details
Reference in a new issue Copy permalink