documentationhelp wanted
Métriques du dépôt
- Stars
- (988 étoiles)
- Métriques de merge PR
- (Métriques PR en attente)
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:
- mdbook is used by Pan Docs.
- Docusaurus is an interesting alternative.
- https://github.com/wavedrom/bitfield can be used for registers, instructions and bitfields in general.
- Hugo is a more heavy-weight option, which can be combined with Docsy to generate complete websites with technical documentation.