Citron/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

55 lines
3.2 KiB
Markdown
Raw Normal View History

# 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)