Uzuy/README.md
Phoenix 2655402a77 docs(readme): updated README.md to reflect Uzuy Edge and what it is
- Updated README to include a description of Uzuy Edge, its features, installation steps, and contribution guidelines.
2024-09-07 19:05:46 +10:00

70 lines
2.4 KiB
Markdown

<div align="center">
# Uzuy Edge
![Uzuy Edge Logo](https://i.imgur.com/SZBZfLx.png)
**Uzuy Edge** is a Nintendo Switch emulator designed for Android devices, focusing on high performance and optimal gaming experience. Play your favorite Nintendo Switch games on your Android device with enhanced performance.
</div>
## Features
- **High Performance:** Optimized for smooth gameplay and minimal lag.
- **Compatibility:** Supports a wide range of Nintendo Switch games.
- **Customizable Settings:** Fine-tune performance to fit your device specifications.
- **User-Friendly Interface:** Easy-to-navigate interface for a seamless experience.
## Installation
### Prerequisites
- Android device running Android 11.0 or higher.
- At least 4 GB of RAM recommended.
### Steps
1. **Download the APK:**
- [Download Link](https://git.uzuy-edge.org/Uzuy-Edge/Uzuy/releases)
2. **Install the APK:**
- Enable installation from unknown sources in your device settings.
- Open the APK file and follow the installation instructions.
3. **Setup:**
- Launch Uzuy Edge and configure settings according to your preferences.
## Usage
1. **Launch the App:** Open Uzuy Edge from your app drawer.
2. **Load Games:** Import your Nintendo Switch game files.
3. **Configure Settings:** Adjust performance settings to optimize gameplay.
4. **Play:** Enjoy your games with enhanced performance.
## License
Uzuy Edge is licensed under the [GPLv3 License](https://git.uzuy-edge.org/Uzuy-Edge/Uzuy/src/branch/master/LICENSE.txt).
## Contributing
I welcome contributions to Uzuy Edge! If you'd like to contribute, please follow these steps:
1. **Fork the Repository:** Click on "Fork" at the top right of the repository page.
2. **Clone Your Fork:** `git clone https://git.uzuy-edge.org/Uzuy-Edge/Uzuy.git`
3. **Create a Branch:** `git checkout -b your-branch-name`
4. **Make Changes:** Edit files and add features.
5. **Commit Your Changes:** `git commit -am 'Add new feature'`
6. **Push to Your Fork:** `git push origin your-branch-name`
7. **Submit a Pull Request:** Go to the original repository and click "New Pull Request."
## Issues
If you encounter any issues, please report them on my [Issues Page](https://git.uzuy-edge.org/Uzuy-Edge/Uzuy/issues).
## Contact
For any inquiries or support, contact me at [phoenix@uzuy-edge.org](mailto:phoenix@uzuy-edge.org).
---
*Uzuy Edge is an open-source project, and I appreciate the support and any contributions from the community.*