From 9427e27e24a7135880ee2881c3c44988e174b41a Mon Sep 17 00:00:00 2001 From: Zephyron Date: Tue, 31 Dec 2024 16:19:25 +1000 Subject: chore: update project branding to citron --- README.md | 140 ++++++++++++++++++++++++-------------------------------------- 1 file changed, 55 insertions(+), 85 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d258584bf..ee6b27b99 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,55 @@ - - -

-
- yuzu -
- yuzu -
-

- -

yuzu is the world's most popular, open-source, Nintendo Switch emulator — started by the creators of Citra. -
-It is written in C++ with portability in mind, and we actively maintain builds for Windows, Linux and Android. -

- -

- - Azure Mainline CI Build Status - - - Discord - -

- -

- Compatibility | - Development | - Building | - Download | - Support | - License -

- -## 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). - -For a full list of games yuzu supports, please visit our [Compatibility page](https://yuzu-emu.org/game/). - -Check out our [website](https://yuzu-emu.org/) 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). - -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). -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) - -## Download - -You can download the latest releases automatically via the installer on our [downloads](https://yuzu-emu.org/downloads/) page. - - -## Support - -If you enjoy the project and want to support us financially, check out our Patreon! - - - - - -Any donations received will go towards things like: -* Switch consoles to explore and reverse-engineer the hardware -* Switch games for testing, reverse-engineering, and implementing new features -* Web hosting and infrastructure setup -* 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. - -## 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. +# Citron - Nintendo Homebrew Emulator 🍋 + +Welcome to **Citron**, a cutting-edge Nintendo Homebrew emulator designed to deliver an optimized experience for playing your favorite games and exploring new ones. Citron is a **high-performance** and **easy-to-use** emulator, tailored for enthusiasts and developers alike. + +> **Disclaimer**: Citron is intended strictly for legal homebrew use and is not affiliated with or endorsed by Nintendo. Use of Citron for pirated or unauthorized copies of games is strictly prohibited. Please respect game developers and support them by purchasing legitimate copies of their games. + +## Features 🛠️ + +- **High Performance**: Optimized for speed and smooth gameplay. +- **User-Friendly**: Clean and intuitive interface. +- **Cross-Platform**: Available on multiple platforms. +- **Homebrew Support**: Fully supports legal homebrew games and applications. +- **Ongoing Development**: Stay tuned for frequent updates as Citron evolves! + +## Download 🚀 + +Ready to experience Citron? [Download the latest version](https://git.citron-emu.org/Citron/Citron/releases) and dive into your favorite Nintendo homebrew titles! + +## Getting Started 💡 + +1. **Download and Install**: Head over to the [downloads page](https://git.citron-emu.org/Citron/Citron/releases) to grab the latest release. +2. **Add Homebrew Games**: Citron is built to play homebrew games. Add them to your game directory and enjoy! +3. **Configure Your Settings**: Customize your emulator settings to suit your performance needs. + +## Source Code 🔧 + +Citron is an open-source project. You can find the source code on our official Git repository: + +- [Citron Source Code](https://git.citron-emu.org/) + +We welcome contributions! Check out the repository and feel free to submit issues or pull requests to help improve Citron. + +## Legal Disclaimer 📜 + +Citron is a **homebrew** emulator designed to support legally created and distributed homebrew software. It does not support piracy, nor is it intended for illegal purposes. Using Citron to play pirated copies of games is a violation of copyright law. Citron is not affiliated with or endorsed by **Nintendo**, and all **Nintendo** trademarks and copyrights are the property of their respective owners. + +> **We highly encourage users to respect intellectual property rights and to only use Citron with legal, homebrew content.** + +## License 📄 + +Citron is licensed under the [GPL License](https://www.gnu.org/licenses/gpl-3.0.html). See the full license in the [LICENSE](LICENSE) file for more details. + +## Contributing ✨ + +We are always looking for developers, testers, and enthusiasts to contribute to Citron. Whether you want to submit a pull request, report an issue, or suggest new features, all contributions are welcome. Please follow our [contributing guidelines](CONTRIBUTING.md) to get started. + +## Contact Us 📬 + +For any inquiries or to follow Citron's development journey, reach out to us: + +- **Official Website**: [https://citron-emu.org](https://citron-emu.org) +- **Source Code**: [https://git.citron-emu.org](https://git.citron-emu.org) +- **Twitter**: [@CitronEmu](https://twitter.com/CitronEmu) + +Made with 💚 by **Zephyron** | [Source Code](https://git.citron-emu.org) \ No newline at end of file -- cgit v1.2.3