This commit improves the readability and understanding of the README file. The changes include simplifying language, removing redundancy, and reorganizing information for better flow. The goal is to make the README more user-friendly, especially for new contributors or users of the yuzu project.
3.1 KiB
yuzu
yuzu is an open-source Nintendo Switch emulator, developed by the creators of Citra. It's written in C++ and is designed to be portable across Windows, Linux, and Android.
Compatibility | Development | Building | Download | Support | License
Compatibility
yuzu can run most commercial games at full speed, given that the necessary hardware requirements are met. Visit our Compatibility page for a full list of supported games.
Development
Development primarily takes place on GitHub, where our central repository is hosted. Join us on Discord for development discussions.
If you're interested in contributing, please review the Contributor's Guide and Developer Information. You can also reach out to our developers on Discord for more information about the emulator's current state.
Building
Instructions for building yuzu can be found here for Windows and Linux.
Download
The latest releases can be downloaded automatically via the installer on our downloads page.
Support
If you appreciate our project and want to support us financially, consider checking out our Patreon!
Donations will be used for:
- Purchasing Switch consoles and games for testing and reverse-engineering
- Web hosting and infrastructure setup
- Software licenses (e.g., Visual Studio, IDA Pro)
- Additional hardware (e.g., GPUs for improving rendering support, other peripherals)
For other ways to support us, join our Discord and talk to bunnei or email: donations@yuzu-emu.org.
License
yuzu is licensed under the GPLv3 (or any later version). Refer to the LICENSE.txt file for more information.