eden-emu/eden
13
3
Fork 4
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
JPikachu 2025-04-12 16:18:43 +00:00
parent d88d690a4e
commit d29d7b931c
1 changed files with 23 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -1,29 +1,26 @@
<!--
SPDX-FileCopyrightText: 2018 yuzu Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later
# SPDX-FileCopyrightText: 2018 yuzu Emulator Project
# SPDX-License-Identifier: GPL-2.0-or-later
# SPDX-FileCopyrightText: 2025 EDEN Emulator Project
# SPDX-License-Identifier: GPL-3.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>
<a href="https://git.eden-emu.dev/eden-emu/eden"><img src="https://git.eden-emu.dev/eden-emu/eden/raw/commit/6ed4bcea0ddb70fe95cb03547eee8e5e70325859/dist/yuzu.svg" alt="Eden" width="200"></a>
<br>
<b>yuzu</b>
<b>Eden</b>
<br>
</h1>
<h4 align="center"><b>yuzu</b> is the world's most popular, open-source, Nintendo Switch emulator — started by the creators of <a href="https://citra-emu.org" target="_blank">Citra</a>.
<h4 align="center"><b>Eden</b> is the world's most popular, open-source, Nintendo Switch emulator forked from Yuzu emulator — started by the former Citron developer Camille LeVay and the Eden team</a>.
<br>
It is written in C++ with portability in mind, and we actively maintain builds for 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">
Discord is not yet public.
</a>
</p>
@ -38,37 +35,38 @@ It is written in C++ with portability in mind, and we actively maintain builds f
## Compatibility
The emulator is capable of running most commercial games at full speed, provided you meet the [necessary hardware requirements](https://yuzu-emu.org/help/quickstart/#hardware-requirements).
The emulator is capable of running most commercial games at full speed, provided you meet the necessary hardware requirements.
For a full list of games yuzu supports, please visit our [Compatibility page](https://yuzu-emu.org/game/).
For a list of games yuzu supports, please be patient as this will come eventually.
Check out our [website](https://yuzu-emu.org/) for the latest news on exciting features, monthly progress reports, and more!
Check out our [website](W.I.P) for the latest news on exciting features, monthly progress reports, and more!
## Development
Most of the development happens on GitHub. It's also where [our central repository](https://github.com/yuzu-emu/yuzu) is hosted. For development discussion, please join us on [Discord](https://discord.com/invite/u77vRWY).
Most of the development happens on our git. It's also where [our central repository](https://git.eden-emu.dev/eden-emu/eden) is hosted. For development discussion, please wait join us on [Discord](W.I.P) once it's public.
If you want to contribute, please take a look at the [Contributor's Guide](https://github.com/yuzu-emu/yuzu/wiki/Contributing) and [Developer Information](https://github.com/yuzu-emu/yuzu/wiki/Developer-Information).
If you want to contribute we are open to new devs and prs, please make sure your work is of a high standard and you have properly documented it.
You can also contact any of the developers on Discord in order to know about the current state of the emulator.
If you want to contribute to the user interface translation project, please check out the [yuzu project on transifex](https://www.transifex.com/yuzu-emulator/yuzu). We centralize translation work there, and periodically upstream translations.
## Building
* __Windows__: [Windows Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Windows)
* __Linux__: [Linux Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Linux)
* __Windows__: [Windows Building Guide](W.I.P)
* __Linux__: [Linux Building Guide](W.I.P)
* __Android__: [Android Building Guide](W.I.P)
## Download
You can download the latest releases automatically via the installer on our [downloads](https://yuzu-emu.org/downloads/) page.
You can download the latest releases from [here](https://git.eden-emu.dev/eden-emu/eden/releases) once public.
## Support
If you enjoy the project and want to support us financially, check 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">
If you enjoy the project and want to support us financially, check out Camille's donations page!
<br>
<br>
Donations are not available yet.
</a>
Any donations received will go towards things like:
@ -78,8 +76,8 @@ Any donations received will go towards things like:
* Software licenses (e.g. Visual Studio, IDA Pro, etc.)
* Additional hardware (e.g. GPUs as-needed to improve rendering support, other peripherals to add support for, etc.)
If you wish to support us a different way, please join our [Discord](https://discord.gg/u77vRWY) and talk to bunnei. You may also contact: donations@yuzu-emu.org.
If you wish to support us a different way, please join our [Discord](W.I.P), once public, and talk to Camille.
## 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.
Eden is licensed under the GPLv3 (or any later version). Refer to the [LICENSE.txt](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/LICENSE.txt) file.