ShuriZma
/
dolphin
mirror of https://github.com/dolphin-emu/dolphin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

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.
## System Requirements
* OS:
* OS
* Microsoft Windows (Vista 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.
* Processor: A CPU with SSE2 support
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).
Direct3D 11 / OpenGL 4.4 recommended.
* Unix-like systems other than Linux might work but are not officially supported.
* Processor
* A CPU with SSE2 support.
* 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).
* Direct3D 11 / OpenGL 4.4 recommended.
## Installation 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.
## Installation on Linux/OS X
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
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.
## 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
* 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
respectively. On Windows the user directory is stored in the "My Documents"
folder by default, but there are various way to override this behavior:
* 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
Dolphin executable.
* 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.
* 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
over this setting.
List of user folders:
* Cache: used to cache the ISO list
* Config: configuration files
* Dump: anything dumped from dolphin
@ -135,5 +138,5 @@ List of user folders:
## Custom textures
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".