From daa562458eee9f18d7a54c0a1c4fe3eb7c7bc2fc Mon Sep 17 00:00:00 2001 From: Lioncash Date: Wed, 29 Jan 2014 08:22:17 -0500 Subject: [PATCH 1/5] Change the readme to use markdown instead of being a regular .txt file. --- Readme.txt => Readme.md | 112 ++++++++++++++++++++-------------------- 1 file changed, 56 insertions(+), 56 deletions(-) rename Readme.txt => Readme.md (64%) diff --git a/Readme.txt b/Readme.md similarity index 64% rename from Readme.txt rename to Readme.md index f4febeef78..ea44f89caf 100644 --- a/Readme.txt +++ b/Readme.md @@ -1,25 +1,25 @@ -Dolphin - A Gamecube / Triforce / Wii Emulator -========================================== -Homesite: http://dolphin-emu.org/ -Project Site: http://code.google.com/p/dolphin-emu +#Dolphin - A Gamecube / Triforce / Wii Emulator + +[Homesite](http://dolphin-emu.org/) | [Project Site](http://code.google.com/p/dolphin-emu) | [Team Members](http://code.google.com/p/dolphin-emu/people/) Dolphin is an emulator for running Gamecube, Triforce and Wii games on Windows/Linux/OS X systems and recent Android devices. It's licensed under the terms of the GNU General Public License, version 2 (GPLv2). -Team members: http://code.google.com/p/dolphin-emu/people/ +Please read the [FAQ](http://dolphin-emu.org/docs/faq/) before use. -Please read the FAQ before use: http://dolphin-emu.org/docs/faq/ +##System Requirements +* 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. -[System Requirements] -* OS: Microsoft Windows (Vista or higher) or 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. -[Installation on Windows] +##Installation on Windows Use the solution file Source/dolphin-emu.sln to build Dolphin on Windows. Visual Studio 2013 is a hard requirement since previous versions don't support many C++ features that we use. Other compilers might be able to build Dolphin @@ -31,25 +31,25 @@ Nullsoft Scriptable Install System (NSIS) to be installed. Creating an installer is not necessary to run Dolphin since the Build directory contains a working Dolphin distribution. -[Installation on Linux/OS X] +##Installation on Linux/OS X -Dolphin requires CMake 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 will inform you if a bundled library is used or if you need to install any missing packages yourself. -Build steps: -mkdir Build -cd Build -cmake .. -make +###Build steps: +1. mkdir Build +2. cd Build +3. cmake .. +4. make On OS X, an application bundle will be created in ./Binaries. On Linux, it's strongly recommended to perform a global installation via "sudo make install". -[Uninstalling] +##Uninstalling When Dolphin has been installed with the NSIS installer, you can uninstall Dolphin like any other Windows application. @@ -61,15 +61,16 @@ OS X users can simply delete Dolphin.app to uninstall it. Additionally, you'll want to remove the global user directory (see below to see where it's stored) if you don't plan to reinstall Dolphin. -[Command line usage] -Usage: Dolphin [-h] [-d] [-l] [-e ] [-b] [-V ] [-A ] - -h, --help Show this help message - -d, --debugger Opens the debugger - -l, --logger Opens the logger - -e, --exec= Loads the specified file (DOL,ELF,WAD,GCM,ISO) - -b, --batch Exit Dolphin with emulator - -V, --video_backend= Specify a video backend - -A, --audio_emulation= Low level (LLE) or high level (HLE) audio +##Command line usage +Usage: Dolphin [-h] [-d] [-l] [-e ] [-b] [-V ] [-A ] + +* -h, --help Show this help message +* -d, --debugger Opens the debugger +* -l, --logger Opens the logger +* -e, --exec= Loads the specified file (DOL,ELF,WAD,GCM,ISO) +* -b, --batch Exit Dolphin with emulator +* -V, --video_backend= Specify a video backend +* -A, --audio_emulation= Low level (LLE) or high level (HLE) audio Available DSP emulation engines are HLE (High Level Emulation) and LLE (Low Level Emulation). HLE is fast but often less accurate while LLE is @@ -80,12 +81,12 @@ Available video backends are "D3D" (only available on Windows Vista or higher), "OGL". There's also "Software Renderer", which uses the CPU for rendering and is intended for debugging purposes, only. -[Sys Files] -totaldb.dsy: Database of symbols (for devs only) -GC/font_ansi.bin: font dumps -GC/font_sjis.bin: font dumps -GC/dsp_coef.bin: DSP dumps -GC/dsp_rom.bin: DSP dumps +##Sys Files +* totaldb.dsy: Database of symbols (for devs only) +* GC/font_ansi.bin: font dumps +* GC/font_sjis.bin: font dumps +* GC/dsp_coef.bin: DSP dumps +* GC/dsp_rom.bin: DSP dumps The DSP dumps included with Dolphin have been written from scratch and do not contain any copyrighted material. They should work for most purposes, however @@ -93,47 +94,46 @@ some games implement copy protection by checksumming the dumps. You will need to dump the DSP files from a console and replace the default dumps if you want to fix those issues. -[Folder structure] +##Folder structure These folders are installed read-only and should not be changed. -GameSettings: per-game default settings database -GC: DSP and font dumps -Maps: symbol tables (dev only) -OpenCL: OpenCL code -Shaders: post-processing shaders -Themes: icon themes for GUI -Wii: default Wii NAND contents +* GameSettings: per-game default settings database +* GC: DSP and font dumps +* Maps: symbol tables (dev only) +* Shaders: post-processing shaders +* Themes: icon themes for GUI +* Wii: default Wii NAND contents -[User folder structure] +##User folder structure A number of user writeable directories are created for caching purposes or for 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 +* 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 +* If the registry string value "LocalUserConfig" exists in "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 +* If the registry string value "UserConfigPath" exists in "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 -GameConfig: additional settings to be applied per-game -GC: memory cards -Load: custom textures -Logs: logs, if enabled -ScreenShots: screenshots taken via Dolphin -StateSaves: save states -Wii: Wii NAND contents +* Cache: used to cache the ISO list +* Config: configuration files +* Dump: anything dumped from dolphin +* GameConfig: additional settings to be applied per-game +* GC: memory cards +* Load: custom textures +* Logs: logs, if enabled +* ScreenShots: screenshots taken via Dolphin +* StateSaves: save states +* Wii: Wii NAND contents -[Custom textures] +##Custom textures Custom textures have to be placed in the user directory under Load/Textures//. You can find the Game ID by right-clicking a game in the ISO list and selecting "ISO Properties". From ab51d142906a3e4582dc4ad7cd151ad801a62a82 Mon Sep 17 00:00:00 2001 From: Lioncash Date: Wed, 29 Jan 2014 09:08:19 -0500 Subject: [PATCH 2/5] Fix formatting within the Readme.md. A little more. Properly escaped the underscores in the Windows registry notation. --- Readme.md | 49 ++++++++++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/Readme.md b/Readme.md index ea44f89caf..36850d9a34 100644 --- a/Readme.md +++ b/Readme.md @@ -1,4 +1,4 @@ -#Dolphin - A Gamecube / Triforce / Wii Emulator +# Dolphin - A Gamecube / Triforce / Wii Emulator [Homesite](http://dolphin-emu.org/) | [Project Site](http://code.google.com/p/dolphin-emu) | [Team Members](http://code.google.com/p/dolphin-emu/people/) @@ -8,18 +8,19 @@ 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: +## System Requirements +* 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. + * 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. -* 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 +## Installation on Windows Use the solution file Source/dolphin-emu.sln to build Dolphin on Windows. Visual Studio 2013 is a hard requirement since previous versions don't support many C++ features that we use. Other compilers might be able to build Dolphin @@ -31,14 +32,13 @@ Nullsoft Scriptable Install System (NSIS) to be installed. Creating an installer is not necessary to run Dolphin since the Build directory contains 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 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 missing packages yourself. -###Build steps: +### Build steps: 1. mkdir Build 2. cd Build 3. cmake .. @@ -49,7 +49,7 @@ On OS X, an application bundle will be created in ./Binaries. On Linux, it's strongly recommended to perform a global installation via "sudo make install". -##Uninstalling +## Uninstalling When Dolphin has been installed with the NSIS installer, you can uninstall Dolphin like any other Windows application. @@ -61,7 +61,7 @@ OS X users can simply delete Dolphin.app to uninstall it. Additionally, you'll want to remove the global user directory (see below to see where it's stored) if you don't plan to reinstall Dolphin. -##Command line usage +## Command line usage Usage: Dolphin [-h] [-d] [-l] [-e ] [-b] [-V ] [-A ] * -h, --help Show this help message @@ -81,7 +81,7 @@ Available video backends are "D3D" (only available on Windows Vista or higher), "OGL". There's also "Software Renderer", which uses the CPU for rendering and is intended for debugging purposes, only. -##Sys Files +## Sys Files * totaldb.dsy: Database of symbols (for devs only) * GC/font_ansi.bin: font dumps * GC/font_sjis.bin: font dumps @@ -94,8 +94,8 @@ some games implement copy protection by checksumming the dumps. You will need 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. +## Folder structure +These folders are installed read-only and should not be changed: * GameSettings: per-game default settings database * GC: DSP and font dumps @@ -104,24 +104,27 @@ These folders are installed read-only and should not be changed. * Themes: icon themes for GUI * Wii: default Wii NAND contents -##User folder structure +## User folder structure A number of user writeable directories are created for caching purposes or for 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 @@ -133,7 +136,7 @@ List of user folders: * StateSaves: save states * Wii: Wii NAND contents -##Custom textures +## Custom textures Custom textures have to be placed in the user directory under -Load/Textures//. 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". From 1d5fab41dc32573313924434d79b7392c4f263d5 Mon Sep 17 00:00:00 2001 From: Lioncash Date: Wed, 29 Jan 2014 09:29:53 -0500 Subject: [PATCH 3/5] Update the Readme.md with suggestions and improvements by neobrain. Updated the "Project Site" link to point to the github page. Also added links to the forums and wiki. Also fixed some list indentation in the system requirements. --- Readme.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/Readme.md b/Readme.md index 36850d9a34..c779adf8d5 100644 --- a/Readme.md +++ b/Readme.md @@ -1,6 +1,6 @@ # Dolphin - A Gamecube / Triforce / Wii Emulator -[Homesite](http://dolphin-emu.org/) | [Project Site](http://code.google.com/p/dolphin-emu) | [Team Members](http://code.google.com/p/dolphin-emu/people/) +[Homepage](http://dolphin-emu.org/) | [Project Site](https://github.com/dolphin-emu/dolphin) | [Forums](http://forums.dolphin-emu.org/) | [Wiki](http://wiki.dolphin-emu.org/) Dolphin is an emulator for running Gamecube, Triforce and Wii games on Windows/Linux/OS X systems and recent Android devices. It's licensed under @@ -11,14 +11,12 @@ Please read the [FAQ](http://dolphin-emu.org/docs/faq/) before use. ## System Requirements * 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. + * 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. + * 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. + * 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. From e015cb0bcac535ded1c5abf817f09a44eb7b277f Mon Sep 17 00:00:00 2001 From: Lioncash Date: Wed, 29 Jan 2014 09:38:56 -0500 Subject: [PATCH 4/5] Move the recommended CPU/GPU sentences onto their own indented line in the system requirements list (thanks go to neobrain for pointing this out). --- Readme.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index c779adf8d5..6956b9c5ca 100644 --- a/Readme.md +++ b/Readme.md @@ -14,9 +14,11 @@ Please read the [FAQ](http://dolphin-emu.org/docs/faq/) before use. * 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. + * 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. + * A reasonably modern graphics card (Direct3D 10.0 / OpenGL 3.0). + * A graphics card that supports Direct3D 11 / OpenGL 4.4 is recommended. ## Installation on Windows Use the solution file Source/dolphin-emu.sln to build Dolphin on Windows. From d7268dd176a2f8ea276694cac9f2a5c54065d372 Mon Sep 17 00:00:00 2001 From: Lioncash Date: Wed, 29 Jan 2014 09:41:34 -0500 Subject: [PATCH 5/5] Add a period in the system requirements list for consistency. --- Readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 6956b9c5ca..a5143078fd 100644 --- a/Readme.md +++ b/Readme.md @@ -10,8 +10,8 @@ Please read the [FAQ](http://dolphin-emu.org/docs/faq/) before use. ## System Requirements * OS - * Microsoft Windows (Vista or higher) - * Linux or Apple Mac OS X (10.7 or higher). + * 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.