Commit Graph

107 Commits

Author SHA1 Message Date
BhaaL
848ea9044c update the Readme to Visual Studio 2017 2017-05-26 15:02:00 +02:00
Léo Lam
89b5549fe0 Include the latest WiiTDB
This allows us to print user friendly names for titles out of the box,
without requiring the user to manually download a title database and
place it in the correct location.

No auto-update mechanism is implemented as it would be substantially
more complicated and overkill (imo), since titles are not updated
that often. I have however added a script to make updating them easier.

The database can be freely used without any restriction. I have
contacted the author.
2017-05-21 18:57:55 +02:00
Anthony
643b218c1d Merge pull request #5443 from JosJuice/readme-android-arch
Readme: Update supported Android CPU architectures
2017-05-19 08:14:15 -07:00
JosJuice
a182e6a078 Readme: Update supported Android CPU architectures
x86-64 support was added by fd0b99b, and at least one person has
been able to run it on Android-x86 (the desktop-oriented fork).
2017-05-19 09:22:07 +02:00
JosJuice
635b74bfeb Remove Windows 10 SDK requirement from readme
This should thankfully not be needed anymore now that
the D3D12 backend has been dropped by 1880a97.
2017-05-19 09:11:09 +02:00
JosJuice
0f1ce0e1f4 Remove incorrect usage of "ASCII" and "ANSI"
Windows-1252 was sometimes being referred to as ASCII or ANSI
in Dolphin, which is incorrect. ASCII is only a subset of
Windows-1252, and ANSI is (rather improperly) used in Windows
to refer to the current code page (which often is 1252 on
Western systems, but can also be something entirely different).

The commit also replaces "SJIS" with "Shift JIS". "SJIS"
isn't misleading, but "Shift JIS" is more commonly used.
2016-12-26 15:49:39 +01:00
Roger
35374066f6 Update Readme.md 2016-12-25 17:47:16 -05:00
Neui
6da062eb6a UICommon: Use $DOLPHIN_EMU_PATH for the user directory, if set 2016-12-20 21:21:31 +01:00
JosJuice
92463ae3ce Revert "Update OS X Requirement to 10.10"
Dolphin works on OS X 10.9 again nowadays.

This reverts commit 93d83ab4d3.
2016-11-05 10:24:51 +01:00
degasus
05eff01229 Android: Update the gradle file to use android studio 2.2 cmake. 2016-10-05 23:44:10 +02:00
Pringo
3f387e5977 Change OS X to macOS in Readme
With the release of 10.12 Sierra OS X is now officially known as macOS. I changed all instances of "OS X" to "macOS" in the readme.

I also made a couple of other minor adjustments. The slash in the title was removed as other slashes were previously removed from the readme and it no longer made much sense with only two items to list. Also the Android section formatting was modified to better match the PC section.
2016-09-21 18:55:28 -07:00
JosJuice
3bb0e7e3f5 Remove AM Baseboard
Let's stop pretending that we support Triforce emulation.
Keeping this code around just in case someone will make
major improvements in the future isn't really worth it.

I'm keeping the Triforce game INIs so users will know that
the compatibility rating for Triforce games is 1 star (broken).
2016-08-11 12:53:44 +02:00
Pierre Bourdon
08e482eae3 Merge pull request #3614 from rukai/LinuxLocalDev
Linux support for portable.txt + documentation in readme
2016-07-10 16:34:33 +02:00
Pringo
93d83ab4d3 Update OS X Requirement to 10.10 2016-07-09 12:35:21 -07:00
Rukai
f42350e719 portable.txt enables portable configuration on linux, README updated to
show how to build a portable and a local dolphin on linux.
2016-07-04 19:39:10 +10:00
JosJuice
b8775b5a98 Update installer script filename in readme
This was changed in 00c21e7.
2016-06-06 21:05:47 +02:00
JosJuice
66be867f4e Update Windows build instructions
Git has been required for a long time, and we also have two
more recent requirements.
2016-04-16 16:51:43 +02:00
Pierre Bourdon
77b4b36ca4 Merge pull request #3670 from aserna3/udev
[udev] Added udev rule for GC adapter
2016-03-11 10:00:41 +01:00
Anthony Serna
99fd27b4fe [udev] Added udev rule for GC adapter
Added rule for DolphinBar
2016-03-10 19:58:47 -06:00
JosJuice
5508991178 Update Windows installer instructions
The Build folder only contains object files, not binaries. The 32-bit
installer isn't useful since Dolphin doesn't support 32-bit anymore.
2016-03-02 18:33:03 +01:00
JosJuice
15995bc825 Correct Windows version requirement in Readme.md 2015-10-02 18:23:54 +02:00
Pringo
783143f474 Update Readme.md
Updated required OS information.
2015-10-01 10:10:01 -07:00
Jules Blok
9cfb411a93 Readme: Update issue tracker URL. 2015-09-07 22:01:19 +02:00
Lioncash
2c88c030f0 Readme: Specify that VS 2015 is to be used instead of VS 2013 2015-09-03 23:57:15 -04:00
sigmabeta
967c19ca74 Android: Add system requirements to Readme.md 2015-07-25 23:25:03 -04:00
sigmabeta
d2c827ec47 Change "Installation' headers to say 'Building' in Readme.md 2015-07-20 13:55:42 -04:00
sigmabeta
658c49fab3 Android:Changes to simplify command-line building of the app, and bugfixes to the Gradle script 2015-07-13 09:37:44 -04:00
sigmabeta
08516ee09e Android: Add detailed instructions for setting up a build environment 2015-07-11 17:14:37 -04:00
Jeffrey Pfau
dfae4e6266 Update Readme with information about more build.properties 2015-06-13 04:04:15 -07:00
Andrew Tolvstad
10e7487dbb Correct Linux uninstall instructions 2015-05-30 18:02:01 -07:00
Justin Chadwick
8cc4342760 Add documentation for Wii network files 2015-05-25 16:11:29 -04:00
Tillmann Karras
4657c7e578 Relicense Dolphin under GPLv2+ 2015-05-25 13:22:31 +02:00
Eder Bastos
140826edd5 Android: Have build.gradle figure out what ABI and Toolchain to use. 2015-05-22 17:13:25 -04:00
Eder Bastos
4cded65320 Android: No longer require specification of NDK or Git paths in build.gradle. 2015-05-19 09:05:35 -04:00
Eder Bastos
9c19d91e18 Android: Allow building of native libraries inside Android Studio / Gradle 2015-05-18 21:20:43 -04:00
Eder Bastos
d2e8750297 Fix the ABI/toolchain table in Readme.md. 2015-05-04 19:31:14 -04:00
Eder Bastos
609a72d90f Add Android build instructions to Readme.md. 2015-05-03 14:28:02 -04:00
Ryan Houdek
618dfe9804 Merge pull request #1749 from Buddybenj/readme
Readme Fixes and Improvements
2015-01-22 18:38:27 -06:00
BhaaL
94af50d669 fix registry paths for portable mode/userdir in Readme.md
we actually read from HKEY_CURRENT_USER/Software/Dolphin Emulator
2014-12-31 22:19:09 +01:00
Benjamin Przybocki
2f020cc48f Readme Fixes and Improvements
These are mostly some edits to clean up inconsistencies in the Readme.

Rationale for the edits:

Switched places of Wii and Triforce in lists. Triforce emulation is pretty obviously not treated with the same importance as GameCube and Wii emulation is and so I feel it makes sense to have it listed last rather than second.

Made the spacing between slashes consistent. In some locations slashes had spaces and in others they didn't. I chose to add spaces throughout as it makes it a bit easier to read.

Gave Linux and OS X separate lines in the system requirements. If Windows gets its own line it makes sense for Linux and OS X to also have their own lines. This also clears up a potential ambiguity in what 10.9 is referring to.

Unified title capitalization. Some titles used capitals for the whole title and others only used capitals for the first word. I decided to capitalize all the titles.

Removed Vista or higher as higher as a requirement for using D3D. As Vista or higher is already a requirement for running Dolphin on Windows this is completely redundant. Also cleaned up a bit of a typo here.
2014-12-21 10:11:27 -06:00
Pringo
88bcfadf50 Update Readme.md
Update OS X requirement to 10.9 as per https://code.google.com/p/dolphin-emu/issues/detail?id=7243
2014-11-25 00:27:13 -05:00
Buddybenj
bd9d2e757c http -> https 2014-11-13 16:50:52 -06:00
Augustin Cavalier
e3f9c82420 README: Add info about "Resources" directory.
Also fix a minor grammar issue.
2014-11-07 09:07:30 -05:00
Stevoisiak
3466158a96 Capitalized Dolphin 2014-10-18 13:16:02 -04:00
Stevoisiak
37da09b27c Specified where GC Bios files go 2014-10-17 16:00:36 -04:00
Lioncash
af7911e9ea Readme: Add a link to the Transifex page 2014-10-13 18:05:58 -04:00
Lioncash
038111b262 Merge pull request #410 from lioncash/coding-style
Introduce the revised coding style.
2014-07-06 19:37:42 -04:00
Lioncash
7b57d64962 Introduce the revised coding style. 2014-07-06 18:20:17 -04:00
Paul Olszewski
5d793881b0 Fix the capitalization of "GameCube" throughout the project. 2014-06-08 11:24:49 +09:00
Tillmann Karras
7c47825038 Readme: add link to issue tracker 2014-02-05 00:42:44 +01:00
Lioncash
ae42c18f84 Correct the dolphin-emu.org links to use https. 2014-01-29 11:03:22 -05:00
Lioncash
df2e542697 Monospace files, folders, keys, and commands within the Readme.md file.
Also bolded the value '1' in the bullet point talking about LocalUserConfig.
2014-01-29 10:40:48 -05:00
Lioncash
d7268dd176 Add a period in the system requirements list for consistency. 2014-01-29 09:41:34 -05:00
Lioncash
e015cb0bca Move the recommended CPU/GPU sentences onto their own indented line in the system requirements list (thanks go to neobrain for pointing this out). 2014-01-29 09:38:56 -05:00
Lioncash
1d5fab41dc 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.
2014-01-29 09:29:53 -05:00
Lioncash
ab51d14290 Fix formatting within the Readme.md. A little more.
Properly escaped the underscores in the Windows registry notation.
2014-01-29 09:08:19 -05:00
Lioncash
daa562458e Change the readme to use markdown instead of being a regular .txt file. 2014-01-29 08:22:17 -05:00