Commit Graph

99 Commits

Author SHA1 Message Date
154ac70833 Fix formatting in Readme
This unhides the dolphin-emu and dolphin-tool convert usage, which were hidden because the backticks preceding them were not on their own line.
2022-10-08 22:28:45 -04:00
c0a7ee2d83 Update Readme links
Fix Transifex link and update formatting.
2022-08-28 21:18:15 -07:00
cdea675827 Fix minor typo in readme 2022-08-10 13:42:09 +10:00
1dbe2a4ea2 Merge pull request #10431 from Zopolis4/readmemakover
Rewrite readme
2022-08-10 14:40:24 +12:00
32d90d5080 Fixing the github wiki link
Its late and I accidently linked to both wikis, this just links to the github wiki
2022-07-07 21:07:44 -07:00
5ed06c2b03 Changing link to github wiki
After some discussion the GitHub wiki is more up to date and would be more useful than the dolphin website's wiki.
2022-07-07 21:04:46 -07:00
8c68d1055a Uncapitalizing wiki 2022-06-25 08:05:12 -07:00
7f5e9c3349 Readme: Referencing the wiki when building for linux
When building dolphin, the wiki has lots of helpful information for dependencies. I am proposing to add a direct link to that page on the wiki under the building for linux section on the README
2022-06-23 10:41:19 -07:00
84944625df Merge pull request #10714 from OatmealDome/macos-mojave-bump
BuildMacOSUniversalBinary: Bump minimum macOS to 10.14
2022-06-02 20:20:52 -04:00
a720e8509b msvc: update min version to VS 17.2.3 2022-06-02 15:52:53 -07:00
cb7e827601 README: Update minimum macOS version 2022-06-01 23:26:32 -04:00
a55192c020 readme: increment min windows version to 10 2022-05-17 02:42:31 -07:00
899be2efe8 readme: make VS min version match the source 2022-05-17 02:42:02 -07:00
c1df874057 Rewrite readme 2022-04-08 21:46:38 +10:00
5e4d1f732d Remove the Maps folder from the Sys directory
It only had two out of date and game-specific maps from decades ago
2022-02-16 12:32:25 +11:00
4008188654 msvc: update to vs2022 and windows sdk 10.0.22000 2021-11-11 08:01:26 -08:00
e5a80995dc Bump minimum macOS to 10.13 High Sierra 2021-08-17 16:27:22 -04:00
e1670df40c Readme: Copy the submodule note to non-Windows sections
Pulling submodules is necessary now that mGBA is integrated.

Perhaps having the same submodule note repeated three times in the
different sections of the readme file is a bit odd, but I don't
know of a fitting section to put it in that isn't OS-specific...
2021-07-22 20:12:58 +02:00
f8575c28ed Fix Readme.md's command line usage 2021-07-17 23:54:48 -03:00
7a44a7ee39 Readme: Update macOS build instructions
1) Place information about universal builds after single architecture builds
   since universal builds are harder to setup the environment for.
2) Specify that new arguments should be provided instead of direct script
   modification for universal builds.
2021-05-22 15:25:18 -07:00
0851693cbe Apple M1: More robust build for universal binaries
- Fixed a typo in the Readme.md
- Made the recursiveMergeBinaries function handle divergent binary file trees
  better.
2021-05-22 15:25:18 -07:00
948764d37b Apple M1: Build, Analytics, and Memory Management
Analytics:
- Incorporated fix to allow the full set of analytics that was recommended by
  spotlightishere

BuildMacOSUniversalBinary:
- The x86_64 slice for a universal binary is now built for 10.12
- The universal binary build script now can be configured though command line
  options instead of modifying the script itself.
- os.system calls were replaced with equivalent subprocess calls
- Formatting was reworked to be more PEP 8 compliant
- The script was refactored to make it more modular
- The com.apple.security.cs.disable-library-validation entitlement was removed

Memory Management:
- Changed the JITPageWrite*Execute*() functions to incorporate support for
  nesting

Other:
- Fixed several small lint errors
- Fixed doc and formatting mistakes
- Several small refactors to make things clearer
2021-05-22 15:25:17 -07:00
4ecb3084b7 Apple M1 Support for MacOS
This commit adds support for compiling Dolphin for ARM on MacOS so that it can
run natively on the M1 processors without running through Rosseta2 emulation
providing a 30-50% performance speedup and less hitches from Rosseta2.

It consists of several key changes:

- Adding support for W^X allocation(MAP_JIT) for the ARM JIT
- Adding the machine context and config info to identify the M1 processor
- Additions to the build system and docs to support building universal binaries
- Adding code signing entitlements to access the MAP_JIT functionality
- Updating the MoltenVK libvulkan.dylib to a newer version with M1 support
2021-05-22 15:25:17 -07:00
3e54d155ac Fix typo in Readme.md 2021-01-29 22:30:24 +01:00
df4f23ff06 Readme: Add Buildbot header link 2020-10-13 23:59:21 +02:00
dee271bae0 Update Readme.md 2020-03-15 18:28:24 -04:00
83b9a11362 Update Readme.md to remove mention of Vista.
Qt no longer supports Vista.
https://doc.qt.io/qt-5.12/windows.html

Dolphin fails to run on Vista.
https://bugs.dolphin-emu.org/issues/11961
2020-01-20 17:46:57 -06:00
da59f97278 Merge pull request #8549 from leoetlino/clang-format-9
Require clang-format 9 and reformat source code
2020-01-13 23:30:26 +01:00
ae6d3be449 Merge pull request #8530 from s-daveb/master
MacOS: Fixes configuration hang; bump MacOS SDK.
2020-01-13 20:21:08 +10:00
4cc2d97294 Require clang-format 9 and reformat source code
This updates the lint script to require clang-format 9 and reformats
existing source code. Since VS2019 ships with clang-format 9 this
should make auto reformats less painful.

This also updates the clang-format configuration to set
BraceWrapping.AfterCaseLabel to true to ensure consistent brace
style; otherwise clang-format 9+ defaults to putting braces on
the same line as switch case labels.
2020-01-08 22:18:15 +01:00
002761d949 Updating Readme.md; bumping req. MacOS version. 2019-12-22 14:33:58 -05:00
12267fb21e Update Readme.md
Reword submodule statement to be more general.
Add pointer about dealing with clang-format.
2019-12-19 11:24:35 -08:00
ffd38ab6e9 Update Readme.md to specify VS2019 as a requirement 2019-11-30 13:42:52 +10:00
fab15edb53 Replace <experimental/filesystem> includes with <filesystem>
https://bugs.dolphin-emu.org/issues/11770
2019-06-20 10:39:56 +02:00
666241ef72 Readme.md: Add hint about Qt submodule under Windows 2019-04-23 22:58:24 +02:00
93d3016e31 Use HTTPS for URLs in Readme & GameSettings INI 2018-12-04 15:12:19 -05:00
5a5d4cad47 Update the Windows SDK version in the Readme file
This was missed in PR 7506.
2018-10-20 08:44:32 +02:00
425e9b4818 [Readme] Updated system requirements 2018-05-25 00:38:15 -07:00
793c6d25f4 Merge pull request #4532 from Neui/env-var-usr-cfg
Use $DOLPHIN_EMU_PATH as an alternative for the user directory
2018-03-26 23:41:27 +02:00
1f226ec14f Update Readme.md and various fixes 2017-12-20 10:54:51 +01:00
4c8f8c011e Merge pull request #4426 from JosJuice/macos-10.9-readme
Revert "Update OS X Requirement to 10.10"
2017-06-05 19:49:31 -07:00
072c161445 upgrade to Windows SDK 10.0.15063.0
this is required for /permissive- to work, because some headers in the
Windows SDK use Microsoft extensions that are not allowed in standards mode
2017-05-28 13:37:31 +02:00
848ea9044c update the Readme to Visual Studio 2017 2017-05-26 15:02:00 +02:00
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
643b218c1d Merge pull request #5443 from JosJuice/readme-android-arch
Readme: Update supported Android CPU architectures
2017-05-19 08:14:15 -07:00
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
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
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
35374066f6 Update Readme.md 2016-12-25 17:47:16 -05:00
6da062eb6a UICommon: Use $DOLPHIN_EMU_PATH for the user directory, if set 2016-12-20 21:21:31 +01:00