Commit Graph

934 Commits

Author SHA1 Message Date
Tim Allen accffa8d1b A tool to check our docs for broken links.
Annoyingly, mkdocs won't validate inter- or intra-document links,
so we'll need to use a third-party tool instead.
2017-08-12 20:58:02 +10:00
Tim Allen 4c4a1dcb67 Fill out the FAQ. 2017-08-12 20:58:02 +10:00
Tim Allen c52b05a0de More mental notes. 2017-08-12 20:58:02 +10:00
Tim Allen 5af4f45a25 Document higan's video sync/audio sync issues. 2017-08-12 20:58:02 +10:00
Tim Allen a350195c8c Describe save states. 2017-08-12 20:58:02 +10:00
Tim Allen 55bae99bb6 More notes. 2017-08-12 20:58:02 +10:00
Tim Allen 0ca6aaf6b7 I've been reminded that region-selection is a thing. 2017-08-12 20:58:02 +10:00
Tim Allen bc9e8c8f4a Document the "no audio → fast forward" behaviour. 2017-08-12 20:58:01 +10:00
Tim Allen b26db6c9b8 Fix a broken link. 2017-08-12 20:58:01 +10:00
Tim Allen 246887d65c Document which drivers people should use. 2017-08-12 20:58:01 +10:00
Tim Allen 0749009652 Be clearer that some drivers don't support the basic shaders. 2017-08-12 20:58:01 +10:00
Tim Allen 3a967430eb Missing last newline. 2017-08-12 20:58:01 +10:00
Tim Allen ce8f008894 Document using shaders. 2017-08-12 20:58:01 +10:00
Tim Allen f6fab1a502 Add higan command-line docs. 2017-08-12 20:58:01 +10:00
Tim Allen a8363c41ba Fix broken link. 2017-08-12 20:58:01 +10:00
Tim Allen e888a607c1 Add a "Manifests and Game Folders" document.
I've occasionally wished for a single "what is a manifest" section I
could link to from other places; this is where it will go.
2017-08-12 20:58:01 +10:00
Tim Allen fb52220b1b Move 'concepts' docs into a concepts folder. 2017-08-12 20:58:01 +10:00
Tim Allen 7760931ffc Link to RTD docs from the README. 2017-08-12 20:58:01 +10:00
Tim Allen df2492c75e Give the Tools doco an intro, like Settings. 2017-08-12 20:58:01 +10:00
Tim Allen 6e6c29138e Make Settings tabs top-level sections.
Just like the tabs of the Tools window.
2017-08-12 20:58:01 +10:00
Tim Allen 5a44f249a4 Separate "how to import" from "what's the game library".
Changed "Configuration" to "Guides", because we want narrative
documentation for all kinds of things, not just documentation.
2017-08-12 20:58:01 +10:00
Tim Allen 3c3f1de317 Convert README docs to MkDocs format.
The existing documentation was getting *way* too long to be a single
document.

I've just bulk moved the existing content into the new structure, but it
definitely needs another pass to make the prose match, fix hyperlinks,
etc. etc.
2017-08-12 20:58:01 +10:00
Tim Allen a99e601c87 Describe the rest of the interesting files. 2017-08-12 20:58:01 +10:00
Tim Allen a62425745b Reminders for the future. 2017-08-12 20:58:01 +10:00
Tim Allen 232bcc0fa7 Fix typos 2017-08-12 20:58:01 +10:00
Tim Allen 926d65cfe0 Describe some files that appear in game folders. 2017-08-12 20:58:01 +10:00
Tim Allen 37a738a1a4 Discuss game patching. 2017-08-12 20:58:01 +10:00
Tim Allen 3e0adb1798 Move the discussion of SD2SNES-optimized MSU-1 patches into a separate paragraph. 2017-08-12 20:58:01 +10:00
Tim Allen f5333c333c I forgot, higan *does* have some Satellaview emulation.
At least, it lets you choose "Satellaview" from the Expansion Port
menu. I have no idea how complete that is.
2017-08-12 20:58:01 +10:00
Tim Allen 427ffd97b8 Update for v103r17. 2017-08-12 20:58:01 +10:00
Tim Allen 8df735e6e2 Minor typo fixes. 2017-08-12 20:58:01 +10:00
Tim Allen b7edf2abcf Reflect the menu-structure of 103r16.
Now that we have a Synchronize Video option again, I've added a place
in the FAQ to address why it does not play well with Synchronize Audio.
2017-08-12 20:58:01 +10:00
Tim Allen 50d5beda53 First draft of MSU-1 import docs. 2017-08-12 20:58:01 +10:00
Tim Allen 65dadd1576 Update the "Audio" tab to match 103r15. 2017-08-12 20:58:01 +10:00
Tim Allen 6f9839df62 Begin the MSU-1 section. 2017-08-12 20:58:01 +10:00
Tim Allen 781f1ff4c0 We should talk about patches at some point. 2017-08-12 20:58:01 +10:00
Tim Allen 66ef548781 Link to the BS-X Project page. 2017-08-12 20:58:00 +10:00
Tim Allen cabb865d5b Fix typo. 2017-08-12 20:58:00 +10:00
Tim Allen 54ffe85479 Document the Super Game Boy. 2017-08-12 20:58:00 +10:00
Tim Allen 362d29c6a7 Make a proper heading for black Game Boy cartridges.
Also, remove the sections for importing and playing Game Boy and GBA
games... the Game Boy section was just going to be about black cartridges
anyway, and I have no idea what the GBA section was going to be for.
2017-08-12 20:58:00 +10:00
Tim Allen ecbc3f6693 Fix underlining for the Satellaview heading. 2017-08-12 20:58:00 +10:00
Tim Allen 1cdd539115 Document the Sufami Turbo. 2017-08-12 20:58:00 +10:00
Tim Allen 1870788cb8 Reword for clarity. 2017-08-12 20:58:00 +10:00
Tim Allen 1b77a4ec8d Use italics for titles. 2017-08-12 20:58:00 +10:00
Tim Allen b02c35edae The official name is "Satellaview".
Not "BS-X", and definitely not "Bandai Satellaview".
2017-08-12 20:58:00 +10:00
Tim Allen e721064fe9 Document how to use BS-X games. 2017-08-12 20:58:00 +10:00
Tim Allen f1e48b90ff Figured out what happens if you're missing firmware files. 2017-08-12 20:58:00 +10:00
Tim Allen 6099424f0f More table cleanups.
Wrap SHA256 hashes in `<code/>` so they'll all be visually the same length.

Make the references from DSP1 and DSP1B to the notes below more obviously
references, not content.

Reword the DSP1 note so that it makes sense even if you didn't just come
from the DSP1/1A row of the table.
2017-08-12 20:58:00 +10:00
Tim Allen 43c5368a30 Clean up table markup.
Use code, not pre, since we want inline markup, not block-level.

The attribute we want is named "rowspan", not "rows".
2017-08-12 20:58:00 +10:00
Tim Allen f4bf02ba02 Replace the awkward nested lists of firmware info with a table. 2017-08-12 20:58:00 +10:00