The Readme is always important
This commit is contained in:
Nicola
GitHub
parent
c50933ca41
commit
c415a671ca
78
README.md
78
README.md
@ -1,27 +1,77 @@
|
||||
# Nuzu
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2022 Nuzu
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
-->
|
||||
|
||||
Welcome to Nuzu, an open-source project aimed at providing an emulator for Nintendo Switch.
|
||||
<h1 align="center">
|
||||
<br>
|
||||
<a href="https://github.com/Nikilites/nuzu/"><img src="https://raw.githubusercontent.com/Nikilites/nuzu/main/logo.png" alt="Nuzu" width="200"></a>
|
||||
<br>
|
||||
<b>Nuzu</b>
|
||||
<br>
|
||||
</h1>
|
||||
|
||||
## Legal Notice
|
||||
<h4 align="center"><b>Nuzu</b> is an open-source Nintendo Switch emulator, designed for legal usage, and developed with portability in mind.
|
||||
<br>
|
||||
It is written in C++ and actively maintained for Windows, Linux, and Android platforms.
|
||||
</h4>
|
||||
|
||||
Nuzu is licensed under the GPLv3 license, allowing for the free redistribution of its source code. It's important to note that Nuzu is designed for legal purposes, and its use is intended to comply with all applicable laws and regulations.
|
||||
<p align="center">
|
||||
<a href="https://github.com/Nikilites/nuzu/actions">
|
||||
<img src="https://img.shields.io/github/workflow/status/Nikilites/nuzu/Build%20and%20Test/main?label=Build%20Status"
|
||||
alt="GitHub Workflow Status">
|
||||
</a>
|
||||
<a href="https://discord.com/invite/nuzu">
|
||||
<img src="https://img.shields.io/discord/1234567890?color=5865F2&label=discord&logo=discord&logoColor=white"
|
||||
alt="Discord">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
### Disclaimer
|
||||
<p align="center">
|
||||
<a href="#compatibility">Compatibility</a> |
|
||||
<a href="#development">Development</a> |
|
||||
<a href="#download">Download</a> |
|
||||
<a href="#support">Support</a> |
|
||||
<a href="#license">License</a>
|
||||
</p>
|
||||
|
||||
Nuzu is developed with the intention of promoting research and development in emulation technology. We want to emphasize that:
|
||||
## Compatibility
|
||||
|
||||
1. **Legal Usage**: Users are permitted to use Nuzu for legal purposes. As developers, we ensure that Nuzu complies with all relevant laws and regulations.
|
||||
Nuzu is capable of running most commercial games at full speed, provided you meet the [necessary hardware requirements](https://github.com/Nikilites/nuzu/wiki/Quickstart#hardware-requirements).
|
||||
|
||||
2. **User Responsibility**: While Nuzu provides the tools for legal emulation, users are responsible for ensuring that their usage of the software complies with copyright laws and other applicable regulations. We cannot be held liable for any misuse of the software.
|
||||
Check out our [website](https://github.com/Nikilites/nuzu/) for the latest news, updates, and more!
|
||||
|
||||
3. **Ethical Considerations**: We encourage users to respect intellectual property rights and only use Nuzu with legally obtained game files. Nuzu should not be used to facilitate or encourage illegal activities, such as piracy.
|
||||
## Development
|
||||
|
||||
### Conclusion
|
||||
Most development activities occur on GitHub. Our [central repository](https://github.com/Nikilites/nuzu) is hosted there. For development discussions, please join us on [Discord](https://discord.com/invite/nuzu).
|
||||
|
||||
Nuzu is a community-driven project aimed at advancing emulation technology in a legal and responsible manner. By using Nuzu, users agree to abide by all relevant laws and regulations. We want to emphasize that Nuzu is a tool for legal emulation, and any illegal usage is the responsibility of the users themselves.
|
||||
If you'd like to contribute, please refer to our [Contributor's Guide](https://github.com/Nikilites/nuzu/wiki/Contributing) and [Developer Information](https://github.com/Nikilites/nuzu/wiki/Developer-Information).
|
||||
You can also contact any of the developers on Discord to learn about the current status of the emulator.
|
||||
|
||||
Thank you for your interest in Nuzu.
|
||||
If you're interested in contributing to our user interface translation project, please visit the [Nuzu project on Transifex](https://www.transifex.com/Nikilites/nuzu). We manage translation work there and regularly incorporate translations.
|
||||
|
||||
---
|
||||
## Download
|
||||
|
||||
For more information about the project and how to get started, please refer to the documentation and resources provided in this repository.
|
||||
You can download the latest releases automatically via the installer on our [Downloads](https://github.com/Nikilites/nuzu/releases) page.
|
||||
|
||||
## Support
|
||||
|
||||
If you appreciate our work and would like to support us financially, consider becoming a Patreon supporter!
|
||||
(NOT A REAL LINK)
|
||||
<a href="https://www.patreon.com/nuzuteam">
|
||||
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
|
||||
</a>
|
||||
|
||||
Donations will be used for various purposes, such as:
|
||||
* Investigating and reverse-engineering Switch hardware
|
||||
* Purchasing Switch games for testing and reverse-engineering
|
||||
* Web hosting and infrastructure setup
|
||||
* Software licenses (e.g., Visual Studio, IDA Pro, etc.)
|
||||
* Additional hardware (e.g., GPUs for rendering support, peripherals for additional feature support, etc.)
|
||||
|
||||
NOT REAL LINK
|
||||
For alternative methods of support, please join our [Discord](https://discord.com/invite/nuzu) and reach out to bunnei. You can also contact us at donations@nuzu.org.
|
||||
|
||||
## License
|
||||
|
||||
Nuzu is licensed under the GPLv3 (or any later version). Refer to the [LICENSE.txt](https://github.com/Nikilites/nuzu/blob/main/LICENSE.txt) file.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user