Miisan
14ce83cc8c
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.
73 lines
3.1 KiB
Markdown
73 lines
3.1 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: 2018 yuzu Emulator Project
|
|
SPDX-License-Identifier: GPL-2.0-or-later
|
|
-->
|
|
|
|
<h1 align="center">
|
|
<br>
|
|
<a href="https://yuzu-emu.org/"><img src="https://raw.githubusercontent.com/yuzu-emu/yuzu-assets/master/icons/icon.png" alt="yuzu" width="200"></a>
|
|
<br>
|
|
yuzu
|
|
<br>
|
|
</h1>
|
|
|
|
<h4 align="center">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.</h4>
|
|
|
|
<p align="center">
|
|
<a href="https://dev.azure.com/yuzu-emu/yuzu/">
|
|
<img src="https://dev.azure.com/yuzu-emu/yuzu/_apis/build/status/yuzu%20mainline?branchName=master"
|
|
alt="Azure Mainline CI Build Status">
|
|
</a>
|
|
<a href="https://discord.com/invite/u77vRWY">
|
|
<img src="https://img.shields.io/discord/398318088170242053?color=5865F2&label=yuzu&logo=discord&logoColor=white"
|
|
alt="Discord">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#compatibility">Compatibility</a> |
|
|
<a href="#development">Development</a> |
|
|
<a href="#building">Building</a> |
|
|
<a href="#download">Download</a> |
|
|
<a href="#support">Support</a> |
|
|
<a href="#license">License</a>
|
|
</p>
|
|
|
|
## Compatibility
|
|
|
|
yuzu can run most commercial games at full speed, given that the necessary hardware requirements are met. Visit our [Compatibility page](https://yuzu-emu.org/game/) for a full list of supported games.
|
|
|
|
## Development
|
|
|
|
Development primarily takes place on GitHub, where our [central repository](https://github.com/yuzu-emu/yuzu) is hosted. Join us on [Discord](https://discord.com/invite/u77vRWY) for development discussions.
|
|
|
|
If you're interested in contributing, please review the [Contributor's Guide](https://github.com/yuzu-emu/yuzu/wiki/Contributing) and [Developer Information](https://github.com/yuzu-emu/yuzu/wiki/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](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Windows) and [Linux](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Linux).
|
|
|
|
## Download
|
|
|
|
The latest releases can be downloaded automatically via the installer on our [downloads](https://yuzu-emu.org/downloads/) page.
|
|
|
|
## Support
|
|
|
|
If you appreciate our project and want to support us financially, consider checking out our Patreon!
|
|
|
|
<a href="https://www.patreon.com/yuzuteam">
|
|
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
|
|
</a>
|
|
|
|
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](https://discord.gg/u77vRWY) 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](https://github.com/yuzu-emu/yuzu/blob/master/LICENSE.txt) file for more information.
|