archive/dolphin
1
0
Fork 0
mirror of https://github.com/dolphin-emu/dolphin.git synced 2024-09-20 11:21:43 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix formatting within the Readme.md. A little more.

Browse source 
Properly escaped the underscores in the Windows registry notation.
This commit is contained in:
Lioncash 2014-01-29 09:08:19 -05:00
parent daa562458e
commit ab51d14290
1 changed files with 26 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
Readme.md
View file

@ -9,15 +9,16 @@ the terms of the GNU General Public License, version 2 (GPLv2).
Please read the [FAQ](http://dolphin-emu.org/docs/faq/) before use. Please read the [FAQ](http://dolphin-emu.org/docs/faq/) before use.
## System Requirements ## System Requirements
* OS: * OS
* Microsoft Windows (Vista or higher) * Microsoft Windows (Vista or higher)
* Linux or Apple Mac OS X (10.7 or higher). * Linux or Apple Mac OS X (10.7 or higher).
* Unix like systems other than Linux might work but are not officially supported. * Unix-like systems other than Linux might work but are not officially supported.
* Processor
* Processor: A CPU with SSE2 support * A CPU with SSE2 support.
A modern CPU (3 GHz and Dual Core, not older than 2008) is highly recommended. * A modern CPU (3 GHz and Dual Core, not older than 2008) is highly recommended.
* Graphics: A reasonably modern graphics card (Direct3D 10.0 / OpenGL 3.0). * Graphics
Direct3D 11 / OpenGL 4.4 recommended. * A reasonably modern graphics card (Direct3D 10.0 / OpenGL 3.0).
* Direct3D 11 / OpenGL 4.4 recommended.
## Installation on Windows ## Installation on Windows
Use the solution file Source/dolphin-emu.sln to build Dolphin on Windows. Use the solution file Source/dolphin-emu.sln to build Dolphin on Windows.
@ -32,7 +33,6 @@ installer is not necessary to run Dolphin since the Build directory contains
a working Dolphin distribution. a working Dolphin distribution.
## Installation on Linux/OS X ## Installation on Linux/OS X
Dolphin requires [CMake](http://www.cmake.org/) for systems other than Windows. Many libraries are Dolphin requires [CMake](http://www.cmake.org/) for systems other than Windows. Many libraries are
bundled with Dolphin and used if they're not installed on your system. CMake bundled with Dolphin and used if they're not installed on your system. CMake
will inform you if a bundled library is used or if you need to install any will inform you if a bundled library is used or if you need to install any
@ -95,7 +95,7 @@ to dump the DSP files from a console and replace the default dumps if you want
to fix those issues. to fix those issues.
## Folder structure ## Folder structure
These folders are installed read-only and should not be changed. These folders are installed read-only and should not be changed:
* GameSettings: per-game default settings database * GameSettings: per-game default settings database
* GC: DSP and font dumps * GC: DSP and font dumps
@ -110,18 +110,21 @@ allowing the user to edit their contents. On OS X and Linux these folders are
stored in ~/Library/Application Support/Dolphin/ and ~/.dolphin-emu stored in ~/Library/Application Support/Dolphin/ and ~/.dolphin-emu
respectively. On Windows the user directory is stored in the "My Documents" respectively. On Windows the user directory is stored in the "My Documents"
folder by default, but there are various way to override this behavior: folder by default, but there are various way to override this behavior:
* Creating a file called "portable.txt" next to the Dolphin executable will * Creating a file called "portable.txt" next to the Dolphin executable will
store the user directory in a local directory called "User" next to the store the user directory in a local directory called "User" next to the
Dolphin executable. Dolphin executable.
* If the registry string value "LocalUserConfig" exists in * If the registry string value "LocalUserConfig" exists in
"HKEY_CURRENT_USER/Dolphin Emulator" and has the value "1", Dolphin will "HKEY\_CURRENT\_USER/Dolphin Emulator" and has the value "1", Dolphin will
always start in portable mode. always start in portable mode.
* If the registry string value "UserConfigPath" exists in * If the registry string value "UserConfigPath" exists in
"HKEY_CURRENT_USER/Dolphin Emulator", the user folders will be stored in the "HKEY\_CURRENT\_USER/Dolphin Emulator", the user folders will be stored in the
directory given by that string. The other two methods will be prioritized directory given by that string. The other two methods will be prioritized
over this setting. over this setting.
List of user folders: List of user folders:
* Cache: used to cache the ISO list * Cache: used to cache the ISO list
* Config: configuration files * Config: configuration files
* Dump: anything dumped from dolphin * Dump: anything dumped from dolphin
@ -135,5 +138,5 @@ List of user folders:
## Custom textures ## Custom textures
Custom textures have to be placed in the user directory under Custom textures have to be placed in the user directory under
Load/Textures/<GameID>/. You can find the Game ID by right-clicking a game Load/Textures/[GameID]/. You can find the Game ID by right-clicking a game
in the ISO list and selecting "ISO Properties". in the ISO list and selecting "ISO Properties".