Tim Allen
b308661fa3
General tidying and tightening of docs.
2017-08-23 17:48:24 +10:00
Tim Allen
a4483339e5
Rename higan-config.md to higan-settings.md
...
The file was originally named `higan-config.md` because the dialog box
it described was called "higan Configuration", which was because the
menu-item to open it was in a menu called "Settings" and it would have
been weird to have a "Settings" item in a "Settings" menu.
Now there are individual menu-items for each tab in the Settings dialog,
none of which are named Settings, so the dialog has been renamed back to
"Settings", and the filename should match.
2017-08-23 17:05:33 +10:00
Tim Allen
1c13f0ad42
Hint more strongly that Linux distros may already have higan packages
2017-08-23 16:57:17 +10:00
Tim Allen
d416bb7231
*facepalm*
2017-08-23 16:56:51 +10:00
Tim Allen
4ba37e6cbe
We're kind of official docs, now.
2017-08-23 16:55:58 +10:00
Tim Allen
6c7a9adaad
Consistently use "folder" over "directory", except for Linux documentation.
...
For Windows documentation, "folder" is the correct term. For generic
documentation, probably either would do but I suspect people are
slightly more likely to be familiar with "folder".
2017-08-23 14:59:16 +10:00
Tim Allen
bafdb09e1b
Let's be consistent about quoting console names here.
2017-08-23 14:52:54 +10:00
Tim Allen
53c0002274
Move the link to the Quick Start section as early as practical.
2017-08-23 14:51:38 +10:00
Tim Allen
15c467b482
This documentation is now up to date as of v104.
2017-08-23 14:51:24 +10:00
Tim Allen
8976438118
Fix all the broken links.
...
Also, some of the text in the higan and icarus settings docs wanted to
link to a discussion of why we ignore manifests by default; now we have
such a thing.
2017-08-22 18:12:17 +10:00
Tim Allen
9be4e59a05
Starting to fix broken links in the documentation.
...
Also, moved the "you should install the GBA BIOS" advice from the
install pages (where I doubt anybody would see it) to the "importing and
playing" guide, which I figure people are more likely to stumble across.
The actually instructions are still in `install/general.md` for lack of
anywhere more appropriate.
2017-08-21 23:29:53 +10:00
Tim Allen
281b22e1c0
Remove leading "What is..." headings from Concepts pages.
...
It's kind of implicit that an article about the concept of X will start
by describing what X is.
2017-08-21 17:07:49 +10:00
Tim Allen
c9c931ecab
Refresh the "game library" documentation.
2017-08-21 17:05:17 +10:00
Tim Allen
58d70c7c9a
Add a link to the bsnes-mercury fork.
...
Also, sort the list of forks by the version they forked from.
2017-08-18 17:20:21 +10:00
Tim Allen
d0b90d0b5c
Break "Manifests and Game Folders" into two articles.
...
Also, substantially re-work each of them.
2017-08-18 15:18:15 +10:00
Tim Allen
e0512b9100
Mention connecting controllers in the console menu.
2017-08-14 21:43:15 +10:00
Tim Allen
08e1f93f71
Update the rest of the settings docs to match the new Video settings.
2017-08-14 18:12:49 +10:00
Tim Allen
6caad914ad
Update the video settings documentation.
2017-08-14 17:51:00 +10:00
Tim Allen
c39ef91307
Fully document the "no audio → too fast" problem.
2017-08-13 00:07:55 +10:00
Tim Allen
f0cf1df4af
Document higan's region-selection features.
2017-08-12 23:41:58 +10:00
Tim Allen
c4425b5fa8
Flesh out the Quick Start documentation.
2017-08-12 22:32:11 +10:00
Tim Allen
722a2d797d
Document the rotation feature.
2017-08-12 20:58:02 +10:00
Tim Allen
60345fe8b5
Describe Game Boy rumble support.
2017-08-12 20:58:02 +10:00
Tim Allen
f3af7f177b
A brief discussion of GBA save types.
2017-08-12 20:58:02 +10:00
Tim Allen
5f67b2a8fc
Finish describing video shader issues.
2017-08-12 20:58:02 +10:00
Tim Allen
1ae228663d
GBC save-states don't work in GB mode, quelle surprise.
2017-08-12 20:58:02 +10:00
Tim Allen
59eb05226f
Finish the section about Game Boy Color games.
2017-08-12 20:58:02 +10:00
Tim Allen
fe9820481f
Start fleshing out the "console-specific notes" section.
2017-08-12 20:58:02 +10:00
Tim Allen
1faa263a4a
Address the idea of multithreading.
2017-08-12 20:58:02 +10:00
Tim Allen
45c8f09330
Be more descriptive about higan's overhead.
2017-08-12 20:58:02 +10:00
Tim Allen
09c9a55588
Give some reasons why games might run slow.
2017-08-12 20:58:02 +10:00
Tim Allen
defb1eedd3
Another entry for the FAQ.
2017-08-12 20:58:02 +10:00
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
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
