aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDjihads <76681596+Djihads80@users.noreply.github.com>2026-10-31 00:10:42 +0100
committerGitHub <noreply@github.com>2026-10-31 00:10:42 +0100
commit2f5d31aad77366f8023a1cff6acd00456c6772d0 (patch)
tree0e528b56e807f3b829e14f675050b5ff38bf501b /README.md
parentd26ed5de848d963ef62165cc3c387c48f35825e0 (diff)
Revise README with updated links and information
Updated Discord links, modified compatibility information, and changed download and donation sections.
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 9 insertions, 29 deletions
diff --git a/README.md b/README.md
index 987d6428e8..03b213dca3 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,11 @@ It's written in C++ with portability in mind, with builds for Windows, Linux, ma
<p align="center">
</a>
- <a href="https://discord.gg/HstXbPch7X">
- <img src="https://img.shields.io/discord/1367654015269339267?color=5865F2&label=Eden&logo=discord&logoColor=white"
+ <a href="https://discord.gg/jCCZ58VExk">
+ <img src="https://img.shields.io/discord/1367654015269339267?color=5865F2&label=Eglantine&logo=discord&logoColor=white"
alt="Discord">
</a>
- <a href="https://stt.gg/qKgFEAbH">
- <img src="https://img.shields.io/revolt/invite/qKgFEAbH?color=d61f3a&label=Stoat"
- alt="Stoat">
- </a>
+
</p>
<p align="center">
@@ -42,25 +39,17 @@ It's written in C++ with portability in mind, with builds for Windows, Linux, ma
## Compatibility
-The emulator is capable of running most commercial games at full speed, provided you meet the necessary hardware requirements.
+The emulator is capable of running Mario Kart World at decent/full speed depending on specs and configurations, and Splatoon Raiders at variable performances
A list of supported games will be available in future. Please be patient.
-Check out our [website](https://eden-emu.dev) for the latest news on exciting features, monthly progress reports, and more!
-
[![Packaging status](https://repology.org/badge/vertical-allrepos/eden-emulator.svg)](https://repology.org/project/eden-emulator/versions)
## Development
-
-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.
+For development discussions, please join us on [Discord](https://discord.gg/jCCZ58VExk)
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
We have a user manual! See our [User Handbook](./docs/user/README.md).
@@ -73,23 +62,14 @@ For information on provided development tooling, see the [Tools directory](./too
## Download
-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.
+You can download the latest releases from [here](https://github.com/Djihads80/Eglantine/releases).
## Support
-If you enjoy the project and would like to support us financially, please check out our developers' [donation pages](https://eden-emu.dev/donations)!
-
-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
+We currently do not take in any donations for the time being
-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.
+If you would prefer to support us in a different way, please join our [Discord](https://discord.gg/jCCZ58VExk)
## License
-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.
+Eden is licensed under the GPLv3 (or any later version). Refer to the [LICENSE.txt](https://github.com/Djihads80/Eglantine/blob/nx2/LICENSE.txt) file.