diff --git a/README.md b/README.md index 7f2294d31..628d0396d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@


- Ryujinx + Ryujinx
Ryujinx
@@ -12,10 +12,11 @@ Ryujinx is an open-source Nintendo Switch emulator, created by gdkchan, written in C#. This emulator aims at providing excellent accuracy and performance, a user-friendly interface and consistent builds. It was written from scratch and development on the project began in September 2017. - Ryujinx is available on Github under the MIT license. + Ryujinx is available on Github under the MIT license.

+ +

+

## Compatibility @@ -39,8 +42,6 @@ As of May 2024, Ryujinx has been tested on approximately 4,300 titles; over 4,100 boot past menus and into gameplay, with roughly 3,550 of those being considered playable. -You can check out the compatibility list [here](https://github.com/Ryujinx/Ryujinx-Games-List/issues). - Anyone is free to submit a new game test or update an existing game test entry; simply follow the new issue template and testing guidelines, or post as a reply to the applicable game issue. Use the search function to see if a game has been tested already! @@ -50,11 +51,6 @@ Use the search function to see if a game has been tested already! To run this emulator, your PC must be equipped with at least 8GiB of RAM; failing to meet this requirement may result in a poor gameplay experience or unexpected crashes. -See our [Setup & Configuration Guide](https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide) on how to set up the emulator. - -For our Local Wireless (LDN) builds, see our [Multiplayer: Local Play/Local Wireless Guide -](https://github.com/Ryujinx/Ryujinx/wiki/Multiplayer-(LDN-Local-Wireless)-Guide). - Avalonia UI comes with translations for various languages. See [Crowdin](https://crwd.in/ryujinx) for more information. ## Latest build @@ -62,10 +58,6 @@ Avalonia UI comes with translations for various languages. See [Crowdin](https:/ These builds are compiled automatically for each commit on the master branch. While we strive to ensure optimal stability and performance prior to pushing an update, our automated builds **may be unstable or completely broken**. -If you want to see details on updates to the emulator, you can visit our [Changelog](https://github.com/Ryujinx/Ryujinx/wiki/Changelog). - -The latest automatic build for Windows, macOS, and Linux can be found on the [Official Website](https://ryujinx.org/download). - ## Documentation If you are planning to contribute or just want to learn more about this project please read through our [documentation](docs/README.md). @@ -81,7 +73,7 @@ Make sure your SDK version is higher or equal to the required version specified ### Step 2 -Either use `git clone https://github.com/Ryujinx/Ryujinx` on the command line to clone the repository or use Code --> Download zip button to get the files. +Either use `git clone https://github.com/KeatonTheBot/Ryujinx` on the command line to clone the repository or use Code --> Download zip button to get the files. ### Step 3 @@ -135,27 +127,6 @@ This folder is located in the user folder, which can be accessed by clicking `Op The emulator has settings for enabling or disabling some logging, remapping controllers, and more. You can configure all of them through the graphical interface or manually through the config file, `Config.json`, found in the user folder which can be accessed by clicking `Open Ryujinx Folder` under the File menu in the GUI. -## Contact - -If you have contributions, suggestions, need emulator support or just want to get in touch with the team, join our [Discord server](https://discord.com/invite/Ryujinx). -You may also review our [FAQ](https://github.com/Ryujinx/Ryujinx/wiki/Frequently-Asked-Questions). - -## Donations - -If you'd like to support the project financially, Ryujinx has an active Patreon campaign. - - - - - -All developers working on the project do so in their free time, but the project has several expenses: -* Hackable Nintendo Switch consoles to reverse-engineer the hardware -* Additional computer hardware for testing purposes (e.g. GPUs to diagnose graphical bugs, etc.) -* Licenses for various software development tools (e.g. Jetbrains, IDA) -* Web hosting and infrastructure maintenance (e.g. LDN servers) - -All funds received through Patreon are considered a donation to support the project. Patrons receive early access to progress reports and exclusive access to developer interviews. - ## License This software is licensed under the terms of the [MIT license](LICENSE.txt). diff --git a/docs/shell.png b/docs/shell.png new file mode 100644 index 000000000..943e18b0e Binary files /dev/null and b/docs/shell.png differ