From a81ec74d060199d87874a498a3764e1da1c13d91 Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Thu, 31 Mar 2022 17:25:47 -0500 Subject: [PATCH 1/6] fixup wine usage --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f3f23a266..e6bddb5ca 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro ## System Requirements ### Minimum - * OS: Windows 7+ x64, or x86-64 Linux with Wine. 32-bit is not supported. + * OS: Windows 7+ x64, or x86-64 operating system with Wine. 32-bit is not supported. + * Wine is not officially supported by us. * GPU: Direct3D 9.0c with Pixel Shader Model 2.x, and Vertex Shader Model 3.0. ## Prerequisites @@ -18,7 +19,7 @@ Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro * WinUSB compliant driver * *Optional, only needed for USB pass-through of original Xbox and Steel Battalion controllers.* -### Wine +### Wine (not officially supported by us) **Please use the latest stable release version of Wine. If it does not work for you, then roll back to Wine 7.0 which is the last known working version.** **There also exists this known [issue](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/issues/2314) which currently prevents savings in some games with the most recent Wine 6.8 and later versions.** * Winetricks From c5fe198bb247cdce5a4b406b24b628d6505bc185 Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Thu, 31 Mar 2022 17:27:47 -0500 Subject: [PATCH 2/6] direct users from readme to official site's download page --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e6bddb5ca..cf1105128 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro * Winpcap is built-in, no installation is required. ## Automated Builds -Cxbx-Reloaded doesn't currently have stable builds, but you can obtain pre-release builds from the Releases tab, or the links below: +Cxbx-Reloaded doesn't currently have stable builds, but you can obtain pre-release builds from our official website's download page, or the links below: - * **[Release Builds](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/releases)** + * **[Release Builds](https://cxbx-reloaded.co.uk/download)** * *[Full build history](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/actions?query=workflow%3A%22GitHub+CI%22)* ## Compatibility From 8dd54df4a8de87e6df914f921db7bb0615226bce Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Thu, 31 Mar 2022 17:29:27 -0500 Subject: [PATCH 3/6] Review remarks --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf1105128..f0fca4626 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,9 @@ Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro ## System Requirements ### Minimum - * OS: Windows 7+ x64, or x86-64 operating system with Wine. 32-bit is not supported. - * Wine is not officially supported by us. + * OS: Windows 7+ x64, or x86-64 Linux with Wine. 32-bit is not supported. + * MacOS with Wine is known not to work, and BSD-based systems are untested. + * Also note that Wine is relatively unstable, and it might break compatibility with Cxbx-Reloaded at any time without warning. * GPU: Direct3D 9.0c with Pixel Shader Model 2.x, and Vertex Shader Model 3.0. ## Prerequisites @@ -19,7 +20,7 @@ Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro * WinUSB compliant driver * *Optional, only needed for USB pass-through of original Xbox and Steel Battalion controllers.* -### Wine (not officially supported by us) +### Wine **Please use the latest stable release version of Wine. If it does not work for you, then roll back to Wine 7.0 which is the last known working version.** **There also exists this known [issue](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/issues/2314) which currently prevents savings in some games with the most recent Wine 6.8 and later versions.** * Winetricks From 7b9634a3eca5fb6bad25647b8464c80dd51d39a8 Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Thu, 31 Mar 2022 17:36:19 -0500 Subject: [PATCH 4/6] fix new line in markdown --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0fca4626..6c2835a41 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro * *Optional, only needed for USB pass-through of original Xbox and Steel Battalion controllers.* ### Wine -**Please use the latest stable release version of Wine. If it does not work for you, then roll back to Wine 7.0 which is the last known working version.** +**Please use the latest stable release version of Wine. If it does not work for you, then roll back to Wine 7.0 which is the last known working version.**
**There also exists this known [issue](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/issues/2314) which currently prevents savings in some games with the most recent Wine 6.8 and later versions.** * Winetricks * `vcrun2019` From 5d87ad46c63263c242198e7107a5c4a5c4b2a7d0 Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Thu, 31 Mar 2022 17:49:24 -0500 Subject: [PATCH 5/6] update speical thanks section --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6c2835a41..c409a1e5f 100644 --- a/README.md +++ b/README.md @@ -114,3 +114,5 @@ You can support [Luke Usher](https://github.com/LukeUsher), initiator of Cxbx-Re * All contributors to the original Cxbx and [Dxbx](https://github.com/PatrickvL/Dxbx) projects. Without them Cxbx-Reloaded would not exist at all. * [XQEMU](https://github.com/xqemu/xqemu) - While the majority of Cxbx-R is our own work (Kernel, HLE, etc), the NV2A LLE and NVNet implementation are primarily the work of the XQEMU developers. * [XboxDev](https://github.com/xboxdev) - Providing Xbox hardware research & useful tooling. +* [XbSymbolDatabase](https://github.com/Cxbx-Reloaded/XbSymbolDatabase) - Providing support to detect symbols across XDK builds from reverse engineered retail titles. +* [Xbox Kernel Test Suite](https://github.com/Cxbx-Reloaded/xbox_kernel_test_suite) - Making accurate tests on hardware to compare against cxbxr's kernel implementation. From 38eeef7c0d8656849cadedde61b851386f533a5c Mon Sep 17 00:00:00 2001 From: RadWolfie Date: Thu, 31 Mar 2022 18:11:03 -0500 Subject: [PATCH 6/6] add readme to informational label --- .github/labeler.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/labeler.yml b/.github/labeler.yml index 067909111..51d27de21 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -28,6 +28,7 @@ HLE: informational: - '**/*Logging*' - '**/*Logging*/**' + - '**/README.md' input: - 'src/common/input/**'