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.
This commit is contained in:
Tim Allen 2017-08-31 14:48:52 +10:00
parent 6b8c003ff8
commit c557d68ec4
17 changed files with 44 additions and 44 deletions

View File

@ -3,7 +3,7 @@ Contributing to higan
If you would like to propose a change to higan, If you would like to propose a change to higan,
you should create an account on the [official forums][f], you should create an account on the [official forums][f],
go to the "Projects" forum and the "higan" subforum, go to the "Projects" forum and the "higan" sub-forum,
and post your idea in a new topic there. and post your idea in a new topic there.
[f]: https://board.byuu.org/ [f]: https://board.byuu.org/

View File

@ -1,7 +1,7 @@
The unofficial higan repository The unofficial higan repository
=============================== ===============================
higan emulates a number of classic videogame consoles of the 1980s and 1990s, higan emulates a number of classic video-game consoles of the 1980s and 1990s,
allowing you to play classic games on a modern general-purpose computer. allowing you to play classic games on a modern general-purpose computer.
This repository includes This repository includes

View File

@ -134,7 +134,7 @@ to all emulators that support them:
Holds streamable audio for [the MSU-1][msu1]. Holds streamable audio for [the MSU-1][msu1].
Files that are only useful to higan specifically Files that are only useful to higan specifically
are placed in a `higan` subfolder: are placed in a `higan` sub-folder:
- `cheats.bml`: - `cheats.bml`:
All information present in All information present in

View File

@ -4,13 +4,13 @@ is the folder where all the
When [icarus](../interface/icarus.md) imports a game, When [icarus](../interface/icarus.md) imports a game,
it creates or updates it creates or updates
the corresponding game folder in the game library. the corresponding game folder in the game library.
When you use the console submenu items When you use the console sub-menu items
in [higan's Library menu](../interface/higan.md#the-library-menu), in [higan's Library menu](../interface/higan.md#the-library-menu),
it higan shows you the games for that console it higan shows you the games for that console
that are already in the library. that are already in the library.
Inside the game library folder Inside the game library folder
there is a subfolder for each system. there is a sub-folder for each system.
Inside each system folder Inside each system folder
are the game folders are the game folders
for each imported game. for each imported game.

View File

@ -96,7 +96,7 @@ If games are running way too fast, here's some things to check:
in [the Advanced settings](interface/higan-settings.md#advanced) in [the Advanced settings](interface/higan-settings.md#advanced)
(remember to restart higan if you change driver settings) (remember to restart higan if you change driver settings)
- Make sure your computer has speakers or headphones connected - Make sure your computer has speakers or headphones connected
(some computers disable all audio if no ouputs are available) (some computers disable all audio if no outputs are available)
- If you want the game to be silent, - If you want the game to be silent,
tick "Mute Audio" in tick "Mute Audio" in
[the Settings menu](interface/higan.md#the-settings-menu) [the Settings menu](interface/higan.md#the-settings-menu)
@ -116,7 +116,7 @@ Full-speed emulation for the Super Famicom base unit
requires an Intel Core 2 Duo (or AMD equivalent), requires an Intel Core 2 Duo (or AMD equivalent),
full-speed for games with the SuperFX chip full-speed for games with the SuperFX chip
requires an Intel Ivy Bridge (or equivalent), requires an Intel Ivy Bridge (or equivalent),
full-speed for the wireframe animations in Mega Man X2 full-speed for the wire-frame animations in Mega Man X2
requires an even faster computer. requires an even faster computer.
Low-power CPUs like ARM chips, Low-power CPUs like ARM chips,
or Intel Atom and Celeron CPUs or Intel Atom and Celeron CPUs
@ -256,8 +256,8 @@ do their work in exactly the same amount of time
as their hardware counterparts. as their hardware counterparts.
The problem is forty years of technology The problem is forty years of technology
designed to make programs run as fast as possible: designed to make programs run as fast as possible:
optimizing compilers optimising compilers
and superscalar, out-of-order CPU architectures and super-scalar, out-of-order CPU architectures
change programs to make them faster, change programs to make them faster,
speeding up some programs more than others speeding up some programs more than others
in ways that are very difficult to understand and predict. in ways that are very difficult to understand and predict.

View File

@ -123,7 +123,7 @@ On Linux:
**Note:** **Note:**
By default, By default,
higan uses the audio driver to regulate its emulation speed. higan uses the audio driver to regulate its emulation speed.
If games run too faston your computer, If games run too fast on your computer,
see [Games run too fast](../faq.md#games-run-too-fast) in the FAQ. see [Games run too fast](../faq.md#games-run-too-fast) in the FAQ.
Input Input

View File

@ -15,7 +15,7 @@ higan's importing tool, icarus, can import games
in the most commonly-used formats in the most commonly-used formats
for each supported console, for each supported console,
and also those same formats inside `.zip` files and also those same formats inside `.zip` files
(as long as tthe `.zip` file contains only one game). (as long as the `.zip` file contains only one game).
More advanced compression formats More advanced compression formats
like RAR or 7-zip are not supported. like RAR or 7-zip are not supported.
@ -36,7 +36,7 @@ See [the icarus documentation](../interface/icarus.md) for details.
To play a game for a particular console from your library, To play a game for a particular console from your library,
open the Library menu, open the Library menu,
pick the console manufacturer submenu pick the console manufacturer sub-menu
(Nintendo for the Super Famicom, (Nintendo for the Super Famicom,
Bandai for the WonderSwan, Bandai for the WonderSwan,
etc.) etc.)
@ -270,7 +270,7 @@ which in English is
[wpbsx]: https://en.wikipedia.org/wiki/Satellaview [wpbsx]: https://en.wikipedia.org/wiki/Satellaview
The control cartridge had a slot that accepted The control cartridge had a slot that accepted
rewritable "memory paks", re-writable "memory paks",
so that people could store the games and data they downloaded. so that people could store the games and data they downloaded.
A small number of games that did not use the Satellaview modem A small number of games that did not use the Satellaview modem
also had a memory pak slot, also had a memory pak slot,
@ -313,7 +313,7 @@ If you load the control cartridge into higan,
make sure the emulated Satellaview make sure the emulated Satellaview
is connected to the emulated Super Famicom's expansion port is connected to the emulated Super Famicom's expansion port
by opening the "Super Famicom" menu, by opening the "Super Famicom" menu,
selecting the "Expansion Port" submenu, selecting the "Expansion Port" sub-menu,
and choosing "Satellaview". and choosing "Satellaview".
If the expansion port was previously If the expansion port was previously
configured with a different option, configured with a different option,
@ -398,7 +398,7 @@ beyond the original Super Game Boy,
but importing and playing games but importing and playing games
works the same way in higan. works the same way in higan.
The Super Game Boy cartrige includes The Super Game Boy cartridge includes
the complete hardware of an original the complete hardware of an original
(black-and-white) (black-and-white)
Game Boy, Game Boy,

View File

@ -9,7 +9,7 @@ reproduce the scanlines and blurring of the original display,
or any other visual effect. or any other visual effect.
The available video shaders are listed in The available video shaders are listed in
the "Video Shaders" submenu of the "Video Shaders" sub-menu of
[the Settings menu](../interface/higan.md#the-settings-menu). [the Settings menu](../interface/higan.md#the-settings-menu).
Which shaders are available depends on Which shaders are available depends on
[video driver](drivers.md#video) higan is configured to use. [video driver](drivers.md#video) higan is configured to use.
@ -43,7 +43,7 @@ higan's emulation of certain consoles
can produce surprising behaviour can produce surprising behaviour
in certain shaders, in certain shaders,
particularly shaders that compare each console pixel particularly shaders that compare each console pixel
with its neigbours. with its neighbours.
See [Video Shaders and TV-based consoles][vstv] for details. See [Video Shaders and TV-based consoles][vstv] for details.
[vstv]: #video-shaders-and-tv-based-consoles [vstv]: #video-shaders-and-tv-based-consoles
@ -92,7 +92,7 @@ you'll need to restart higan
for the change to take effect. for the change to take effect.
Open the Settings menu again, Open the Settings menu again,
choose the "Video Shader" submenu, choose the "Video Shader" sub-menu,
and now the shaders you installed and now the shaders you installed
should be listed at the bottom of the menu. should be listed at the bottom of the menu.
@ -132,7 +132,7 @@ but some are particularly noteworthy:
and shimmer and shimmer
that most game players would have seen that most game players would have seen
on real televisions. on real televisions.
Some games depend on NTSC artifacts Some games depend on NTSC artefacts
to display colours outside the console's official palette to display colours outside the console's official palette
or to create effects like transparency. or to create effects like transparency.

View File

@ -1,7 +1,7 @@
higan, the multi-system emulator higan, the multi-system emulator
================================ ================================
higan emulates a number of classic videogame consoles of the 1980s and 1990s, higan emulates a number of classic video-game consoles of the 1980s and 1990s,
allowing you to play classic games on a modern general-purpose computer. allowing you to play classic games on a modern general-purpose computer.
To get started with higan right away, To get started with higan right away,
@ -15,24 +15,24 @@ As of v104,
higan has top-tier support for the following consoles: higan has top-tier support for the following consoles:
- Nintendo Super Famicom/Super Nintendo Entertainment System, - Nintendo Super Famicom/Super Nintendo Entertainment System,
including addon hardware: including add-on hardware:
- Super Game Boy - Super Game Boy
- Sufami Turbo - Sufami Turbo
- Nintendo Game Boy Advance - Nintendo Game Boy Advance
It also includes some level of support for these consoles: It also includes some level of support for these consoles:
- Satellaview addon for the Super Famicom - Satellaview add-on for the Super Famicom
- Nintendo Famicom/Nintendo Entertainment System - Nintendo Famicom/Nintendo Entertainment System
- Nintendo Game Boy - Nintendo Game Boy
- Nintendo Game Boy Color - Nintendo Game Boy Color
- Sega Master System - Sega Master System
- Sega Game Gear - Sega Game Gear
- Sega Megadrive/Genesis - Sega Mega Drive/Genesis
- NEC PC Engine/TurboGrafx 16 (but not the CD-ROM² System/TurboGrafx-CD) - NEC PC Engine/TurboGrafx 16 (but not the CD-ROM² System/TurboGrafx-CD)
- NEC SuperGrafx - NEC SuperGrafx
- Bandai WonderSwan - Bandai WonderSwan
- Bandai Wonderswan Color - Bandai WonderSwan Color
**Note:** Some consoles were released under different names **Note:** Some consoles were released under different names
in different geographic regions. in different geographic regions.
@ -103,7 +103,7 @@ that you might want to check out.
- [BizHawk](http://tasvideos.org/BizHawk.html) - [BizHawk](http://tasvideos.org/BizHawk.html)
is another multi-system emulator, is another multi-system emulator,
specialising in the creation of specialising in the creation of
tool-assisted speedruns. tool-assisted speed-runs.
Its Super Famicom emulation is based on bsnes v087. Its Super Famicom emulation is based on bsnes v087.
- [bsnes-plus](https://github.com/devinacker/bsnes-plus) - [bsnes-plus](https://github.com/devinacker/bsnes-plus)
is a fork of bsnes v073 is a fork of bsnes v073
@ -119,4 +119,4 @@ that you might want to check out.
It also restores the "balanced" Super Famicom emulation core It also restores the "balanced" Super Famicom emulation core
that was removed from higan in v099, that was removed from higan in v099,
which is less CPU intensive which is less CPU intensive
than the current accuracy-focussed core. than the current accuracy-focused core.

View File

@ -19,7 +19,7 @@ for the same legal reasons that commercial games
cannot be distributed with higan, cannot be distributed with higan,
so you'll need to obtain a copy of the BIOS for yourself. so you'll need to obtain a copy of the BIOS for yourself.
If you have a real GBA and a flashcart, If you have a real GBA and a flash-cart,
the Internet contains many tools the Internet contains many tools
that will extract the BIOS image so it can be copied that will extract the BIOS image so it can be copied
to your desktop computer. to your desktop computer.

View File

@ -29,7 +29,7 @@ To remove higan's configuration:
1. Press Win+R to open the Run dialog 1. Press Win+R to open the Run dialog
2. Type `%LOCALAPPDATA%` and press Enter 2. Type `%LOCALAPPDATA%` and press Enter
to open the folder where higan's configuration data lives to open the folder where higan's configuration data lives
3. Delete the subfolders named `icarus` and `higan` 3. Delete the sub-folders named `icarus` and `higan`
if they exist. if they exist.
You might also want to remove You might also want to remove

View File

@ -5,7 +5,7 @@ Sometimes higan will need you
to choose a file or folder. to choose a file or folder.
For this, it uses a special Filesystem Browser dialog. For this, it uses a special Filesystem Browser dialog.
Although many operating systems provide a native filesystem browser, Although many operating systems provide a native filesystem browser,
they do not all allow the same customizations. they do not all allow the same customisations.
Therefore, Therefore,
higan provides its own filesystem browser higan provides its own filesystem browser
that works the same way on every platform. that works the same way on every platform.
@ -55,7 +55,7 @@ you can choose one
by selecting it and clicking the "Select" button in the bottom-right. by selecting it and clicking the "Select" button in the bottom-right.
Double-clicking Double-clicking
or selecting and pressing Enter don't work, or selecting and pressing Enter don't work,
they just switch to viewing the conents of that folder. they just switch to viewing the contents of that folder.
The "Cancel" button in the bottom-right The "Cancel" button in the bottom-right
closes the filesystem browser without selecting anything. closes the filesystem browser without selecting anything.

View File

@ -30,7 +30,7 @@ of the emulated console's video output:
This is in addition to This is in addition to
any adjustment applied by any adjustment applied by
the "Colors" option the "Colors" option
in the "Video Emulation" submenu in the "Video Emulation" sub-menu
of the [Settings menu](higan.md#the-settings-menu). of the [Settings menu](higan.md#the-settings-menu).
- **Luminance** adjusts the overall brightness, - **Luminance** adjusts the overall brightness,
where 100% is normal, where 100% is normal,
@ -87,7 +87,7 @@ in a normal window.
whenever it changes size whenever it changes size
(because the user loaded a game for a different console, (because the user loaded a game for a different console,
chose a different option from chose a different option from
the [Video Scale submenu](higan.md#the-settings-menu), the [Video Scale sub-menu](higan.md#the-settings-menu),
toggled Aspect Correction, etc.) toggled Aspect Correction, etc.)
When disabled, When disabled,
higan generally respects manual resizing. higan generally respects manual resizing.

View File

@ -8,7 +8,7 @@ the running game's video output.
The Library menu The Library menu
---------------- ----------------
Manufacturer submenus Manufacturer sub-menus
allow you to play allow you to play
games you've already imported games you've already imported
into higan's into higan's
@ -145,7 +145,7 @@ that aren't technically part of the console itself:
how the low-resolution video output of the emulated console how the low-resolution video output of the emulated console
is scaled up to suit modern high-resolution displays. is scaled up to suit modern high-resolution displays.
[Using video shaders](../guides/shaders.md) [Using video shaders](../guides/shaders.md)
describes all the options in this submenu. describes all the options in this sub-menu.
**Synchronize Audio** **Synchronize Audio**
causes higan to wait for audio playback to complete causes higan to wait for audio playback to complete
@ -154,7 +154,7 @@ This should reduce popping and glitching noises,
and slows the emulation down to approximately the correct speed. and slows the emulation down to approximately the correct speed.
If your PC cannot emulate at full-speed, If your PC cannot emulate at full-speed,
(60fps for most consoles, 75fps for WonderSwan) (60fps for most consoles, 75fps for WonderSwan)
this has no noticable effect. this has no noticeable effect.
**Mute Audio** **Mute Audio**
causes higan to not output sound from the emulated console. causes higan to not output sound from the emulated console.
@ -236,7 +236,7 @@ Before any game is loaded,
the status bar displays "No cartridge loaded". the status bar displays "No cartridge loaded".
When a game is loaded and running, When a game is loaded and running,
the status bar displays the current emulation speeed the status bar displays the current emulation speed
in frames-per-second. in frames-per-second.
For PAL-based consoles, For PAL-based consoles,
this should be around 50 FPS for "full speed" emulation, this should be around 50 FPS for "full speed" emulation,
@ -271,7 +271,7 @@ The status bar briefly displays "Slot X quick state does not exist"
(where X is one of the Quick State slot numbers) (where X is one of the Quick State slot numbers)
when you choose a slot from the when you choose a slot from the
[Tools](#the-tools-menu) → "Load Quick State" [Tools](#the-tools-menu) → "Load Quick State"
submenu that has not had a save-state saved to it, sub-menu that has not had a save-state saved to it,
or when you press the "Load Quick State" hotkey or when you press the "Load Quick State" hotkey
while the current Quick State slot has not had a save-state saved to it, while the current Quick State slot has not had a save-state saved to it,

View File

@ -60,7 +60,7 @@ The icarus Settings dialog contains the following settings:
if it's importing a game it recognises. if it's importing a game it recognises.
For unrecognised games, For unrecognised games,
and for all games if this box is unticked, and for all games if this box is unticked,
icarus gueses the manifest data. icarus guesses the manifest data.
This option is still relevant when "Create Manifests" is unticked: This option is still relevant when "Create Manifests" is unticked:
higan uses icarus to generate a manifest when a game is loaded, higan uses icarus to generate a manifest when a game is loaded,
not just at import-time. not just at import-time.

View File

@ -37,7 +37,7 @@ Playing Game Boy Color games in Game Boy mode
Games for the original Game Boy Games for the original Game Boy
came in solid grey cartridges, came in solid grey cartridges,
and only supported four-shade greyscale graphics. and only supported four-shade grey-scale graphics.
ROM files for these games ROM files for these games
typically have filenames ending in `.gb`. typically have filenames ending in `.gb`.
@ -54,7 +54,7 @@ typically have filenames ending in `.gbc`.
However, However,
there were also some games there were also some games
that could use colour if it was available, that could use colour if it was available,
but would stick to greyscale if it wasn't. but would stick to grey-scale if it wasn't.
These games came in black cartridges. These games came in black cartridges.
ROM files for these games ROM files for these games
typically have filenames ending in `.gbc` typically have filenames ending in `.gbc`
@ -153,9 +153,9 @@ Rumble compatibility for Game Boy Advance
The original Game Boy Advance The original Game Boy Advance
and the Game Boy Advance SP and the Game Boy Advance SP
did not support any kind of rumble or force-feedback system, did not support any kind of rumble or force-feedback system,
but the Game Boy Player addon for the Gamecube but the Game Boy Player add-on for the GameCube
allowed Game Boy Advance games allowed Game Boy Advance games
to use the rumble feature in Gamecube controllers. to use the rumble feature in GameCube controllers.
Because rumble is a feature of the Game Boy Player, Because rumble is a feature of the Game Boy Player,
to experience the rumble effect in higan to experience the rumble effect in higan

View File

@ -79,11 +79,11 @@ that's a Super Famicom game
so there will be a Super Famicom menu. so there will be a Super Famicom menu.
Open [the console menu](interface/higan.md#the-console-menu), Open [the console menu](interface/higan.md#the-console-menu),
and if there is a submenu for a controller port, and if there is a sub-menu for a controller port,
make sure the port is using make sure the port is using
the controller you [set up previously](#configuring-inputs). the controller you [set up previously](#configuring-inputs).
If you configured inputs for a Gamepad in Controller Port 1, If you configured inputs for a Gamepad in Controller Port 1,
the Controller Port 1 submenu the Controller Port 1 sub-menu
should be set to Gamepad. should be set to Gamepad.
Like a real console, Like a real console,
higan's controller ports higan's controller ports