Uzuy/README.md

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

70 lines
2.4 KiB
Markdown
Raw Normal View History

<div align="center">
2024-03-04 00:57:21 +00:00
# Uzuy Edge
2024-03-04 00:57:21 +00:00
![Uzuy Edge Logo](https://i.imgur.com/SZBZfLx.png)
2024-03-04 00:57:21 +00:00
**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.
2024-03-04 00:57:21 +00:00
</div>
chore: make yuzu REUSE compliant [REUSE] is a specification that aims at making file copyright information consistent, so that it can be both human and machine readable. It basically requires that all files have a header containing copyright and licensing information. When this isn't possible, like when dealing with binary assets, generated files or embedded third-party dependencies, it is permitted to insert copyright information in the `.reuse/dep5` file. Oh, and it also requires that all the licenses used in the project are present in the `LICENSES` folder, that's why the diff is so huge. This can be done automatically with `reuse download --all`. The `reuse` tool also contains a handy subcommand that analyzes the project and tells whether or not the project is (still) compliant, `reuse lint`. Following REUSE has a few advantages over the current approach: - Copyright information is easy to access for users / downstream - Files like `dist/license.md` do not need to exist anymore, as `.reuse/dep5` is used instead - `reuse lint` makes it easy to ensure that copyright information of files like binary assets / images is always accurate and up to date To add copyright information of files that didn't have it I looked up who committed what and when, for each file. As yuzu contributors do not have to sign a CLA or similar I couldn't assume that copyright ownership was of the "yuzu Emulator Project", so I used the name and/or email of the commit author instead. [REUSE]: https://reuse.software Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-15 00:06:02 +00:00
## Features
2018-01-15 02:53:58 +00:00
- **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.
2016-01-16 07:30:22 +00:00
## Installation
### Prerequisites
- Android device running Android 11.0 or higher.
- At least 4 GB of RAM recommended.
2014-12-16 01:34:44 +00:00
### Steps
2014-04-08 19:05:45 +00:00
1. **Download the APK:**
- [Download Link](https://git.uzuy-edge.org/Uzuy-Edge/Uzuy/releases)
2016-02-25 07:42:34 +00:00
2. **Install the APK:**
- Enable installation from unknown sources in your device settings.
- Open the APK file and follow the installation instructions.
2014-04-08 19:05:45 +00:00
3. **Setup:**
- Launch Uzuy Edge and configure settings according to your preferences.
2014-04-08 19:05:45 +00:00
## 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.
2014-04-08 19:05:45 +00:00
## License
2014-12-16 01:01:56 +00:00
Uzuy Edge is licensed under the [GPLv3 License](https://git.uzuy-edge.org/Uzuy-Edge/Uzuy/src/branch/master/LICENSE.txt).
2014-12-16 01:01:56 +00:00
## Contributing
2021-06-24 06:32:41 +00:00
I welcome contributions to Uzuy Edge! If you'd like to contribute, please follow these steps:
2021-06-24 06:32:41 +00:00
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."
2021-06-24 06:32:41 +00:00
## Issues
2021-06-24 06:32:41 +00:00
If you encounter any issues, please report them on my [Issues Page](https://git.uzuy-edge.org/Uzuy-Edge/Uzuy/issues).
2021-06-24 06:32:41 +00:00
## Contact
2018-01-13 22:28:52 +00:00
For any inquiries or support, contact me at [phoenix@uzuy-edge.org](mailto:phoenix@uzuy-edge.org).
2021-06-24 06:32:41 +00:00
---
2021-06-24 06:32:41 +00:00
*Uzuy Edge is an open-source project, and I appreciate the support and any contributions from the community.*