StrikerX3/Ymir

Write documentation about the Saturn's hardware

Open

#5 opened on Apr 30, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (52 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (988 stars)
PR merge metrics
 (PR metrics pending)

Description

Existing documentation is... mediocre, at best. It was a challenge to write a Sega Saturn emulator from scratch using what was accessible at the time of this writing. The method that worked for me was combining the documentation, the remains of existing research by various people, some Dreamcast docs, and peeking at the source code of established emulators Mednafen and Yaba Sanshiro.

The goal here is to write a comprehensive technical guide to the Saturn's hardware targeting homebrew developers in the same vein as the Pan Docs for the GameBoy and a version for emulator developers similar to Game Boy: Complete Technical Reference so that future developers don't have to suffer as much as I did.

As for documentation tools:

Contributor guide