Tim Allen
87e2154ea1
Update the link to the nightly builds.
2018-05-19 12:54:41 +10:00
Tim Allen
c557d68ec4
Spell-check the documentation.
...
Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 14:48:52 +10:00
Tim Allen
7760931ffc
Link to RTD docs from the README.
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
Tim Allen
8c3d076bf4
Link to the official game folder docs.
2017-08-12 20:58:00 +10:00
Tim Allen
788bdb0ae2
Document importing regular and co-processor games.
2017-08-12 20:58:00 +10:00
Tim Allen
39822bc123
A rewording inspired by a forum thread.
...
Introduce the idea of "the console a game was intended to run on",
so it doesn't come out of left field in the "To play a game" instructions.
2017-08-12 20:58:00 +10:00
Tim Allen
6ba931987b
Fix typo.
2017-08-12 20:58:00 +10:00
Tim Allen
4c4339d313
Add pointers to importing hints.
2017-08-12 20:57:59 +10:00
Tim Allen
d166c280c7
Add some TODO markers for completeness.
2017-08-12 20:57:59 +10:00
Tim Allen
73a37beae1
Fix typo.
2017-08-12 20:57:59 +10:00
Tim Allen
b61ca253de
Document icarus.
2017-08-12 20:57:59 +10:00
Tim Allen
0ed9737dd4
We should document what goes into a game folder.
2017-08-12 20:57:59 +10:00
Tim Allen
adddc1dc0a
We're going to need to document icarus, too.
2017-08-12 20:57:59 +10:00
Tim Allen
b021f5186c
Move "Moving the Game Library" into its own section.
...
Also, move the higher-level questions about the game library
and game folders to the end of the section,
so people can more easily find the bits about importing types of game.
2017-08-12 20:57:59 +10:00
Tim Allen
1a68cb65eb
Document higan's custom filesystem browser.
2017-08-12 20:57:59 +10:00
Tim Allen
82a64bb3ab
Describe the Manifest Viewer.
2017-08-12 20:57:59 +10:00
Tim Allen
75f842cdb2
At least link to Quick Start near the top of the doc.
2017-08-12 20:57:59 +10:00
Tim Allen
9362726c65
Found some more info about higan and vsync.
2017-08-12 20:57:59 +10:00
Tim Allen
a3e1983d50
Remind myself to update the Video tab docs when it settles.
2017-08-12 20:57:59 +10:00
Tim Allen
20e3fdd1e3
higan 103r11 removed the "Mask Overscan" option.
2017-08-12 20:57:59 +10:00
Tim Allen
0bb6a3b0bc
Document the State Manager.
2017-08-12 20:57:59 +10:00