aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDjihads <76681596+Djihads80@users.noreply.github.com>2026-10-29 02:08:56 +0100
committerGitHub <noreply@github.com>2026-10-29 02:08:56 +0100
commit1af7fe72927af9fc64aa4af117bc9b30043c4dc7 (patch)
treee4d23143900184630deeabe27eab1321dac4a428 /README.md
parent26a03d2473787abf3223b2d0e65b291eee00c1e1 (diff)
Rename project to Eglantine and enhance README
Updated project name from 'Eden' to 'Eglantine' and revised related descriptions. Added development section and updated support information.
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 25 insertions, 20 deletions
diff --git a/README.md b/README.md
index 7d3fe5572e..987d6428e8 100644
--- a/README.md
+++ b/README.md
@@ -9,15 +9,14 @@
<h1 align="center">
<br>
- <a href="https://git.eden-emu.dev/eden-emu/eden"><img src="./dist/qt_themes/default/icons/256x256/eden.png" alt="Eden" width="200"></a>
+ <a href="https://git.eden-emu.dev/eden-emu/eden"><img src="https://github.com/user-attachments/assets/35031845-4bfa-4916-8bf5-bc3bce67d5e2" alt="Eglantine" width="200"></a>
<br>
- <b>Eden</b>
+ <b>Eglantine</b>
<br>
</h1>
-<h4 align="center"><b>Eden</b> is a free and open-source (FOSS) Switch 1 emulator started by developer Camille LaVey.
-<br>
-Written in C++, with builds for Windows, Linux, macOS, Android, FreeBSD and more.
+<h4 align="center"><b>Eglantine</b> is a free and opensource (FOSS) Switch 2 emulator, derived from Eden, Yuzu and Sudachi - started by developer Camille LaVey.
+It's written in C++ with portability in mind, with builds for Windows, Linux, macOS, Android, FreeBSD and more.
</h4>
<p align="center">
@@ -51,9 +50,16 @@ Check out our [website](https://eden-emu.dev) for the latest news on exciting fe
[![Packaging status](https://repology.org/badge/vertical-allrepos/eden-emulator.svg)](https://repology.org/project/eden-emulator/versions)
-## Contribute
+## Development
-To contribute to Eden; be it financially, code, bug reports, or otherwise, see our [Contributing guidelines](./CONTRIBUTING.md).
+Most of the development happens on our Git server. It is also where [our central repository](https://git.eden-emu.dev/eden-emu/eden) is hosted. For development discussions, please join us on [Discord](https://discord.gg/HstXbPch7X) or [Stoat](https://stt.gg/qKgFEAbH).
+You can also follow us on [X (Twitter)](https://nitter.poast.org/edenemuofficial) for updates and announcements.
+
+If you would like to contribute, we are open to new developers and pull requests. Please ensure that your work is of a high standard and properly documented. You can also contact any of the developers on Discord or Stoat to learn more about the current state of the emulator.
+
+See the [sign-up instructions](docs/SIGNUP.md) for information on registration.
+
+Alternatively, if you wish to add translations, go to the [Eden project on Transifex](https://app.transifex.com/edenemu/eden-emulator) and review [the translations README](./dist/languages).
## Documentation
@@ -67,24 +73,23 @@ For information on provided development tooling, see the [Tools directory](./too
## Download
-You can download the latest releases from [our release page](https://git.eden-emu.dev/eden-emu/eden/releases).
+You can download the latest releases from [here](https://git.eden-emu.dev/eden-emu/eden/releases).
Save us some bandwidth! We have [mirrors available](./docs/user/ThirdParty.md#mirrors) as well.
-## License
+## Support
-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.
+If you enjoy the project and would like to support us financially, please check out our developers' [donation pages](https://eden-emu.dev/donations)!
-## Special thanks
+Any donations received will go towards things such as:
+* Switch consoles to explore and reverse-engineer the hardware
+* Switch games for testing, reverse-engineering, and implementing new features
+* Web hosting and infrastructure setup
+* Additional hardware (e.g. GPUs as needed to improve rendering support, other peripherals to add support for, etc.)
+* CI Infrastructure
-Super special thanks to Cloudflare for preventing the git server from blowing up.
+If you would prefer to support us in a different way, please join our [Discord](https://discord.gg/HstXbPch7X) and talk to Camille or any of our other developers.
-- Yuzu
-- Ryujinx
-- Sudachi
-- Citron
-- Torzu
-- Suyu
-- Ryubing
+## License
-And everyone who continues or had contributed to the project! <3
+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.