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-14 20:06:02 -04:00
<!--
SPDX-FileCopyrightText: 2018 yuzu Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later
-->
2021-06-24 02:32:41 -04:00
< h1 align = "center" >
< br >
< a href = "https://yuzu-emu.org/" > < img src = "https://raw.githubusercontent.com/yuzu-emu/yuzu-assets/master/icons/icon.png" alt = "yuzu" width = "200" > < / a >
< br >
2021-06-24 02:37:03 -04:00
< b > yuzu< / b >
2021-06-24 02:32:41 -04:00
< br >
< / h1 >
2018-01-14 21:53:58 -05:00
2021-06-24 02:32:41 -04:00
< h4 align = "center" > < b > yuzu< / b > is the world's most popular, open-source, Nintendo Switch emulator — started by the creators of < a href = "https://citra-emu.org" target = "_blank" > Citra< / a > .
< br >
2023-06-03 10:29:26 -04:00
It is written in C++ with portability in mind, and we actively maintain builds for Windows, Linux and Android.
2021-06-24 02:32:41 -04:00
< / h4 >
2016-01-16 02:30:22 -05:00
2021-06-24 02:32:41 -04:00
< p align = "center" >
< a href = "https://dev.azure.com/yuzu-emu/yuzu/" >
< img src = "https://dev.azure.com/yuzu-emu/yuzu/_apis/build/status/yuzu%20mainline?branchName=master"
alt="Azure Mainline CI Build Status">
< / a >
< a href = "https://discord.com/invite/u77vRWY" >
2021-12-06 05:39:55 -05:00
< img src = "https://img.shields.io/discord/398318088170242053?color=5865F2&label=yuzu&logo=discord&logoColor=white"
2021-06-24 02:32:41 -04:00
alt="Discord">
< / a >
< / p >
2014-04-28 12:21:41 -04:00
2021-06-24 02:32:41 -04:00
< p align = "center" >
< a href = "#compatibility" > Compatibility< / a > |
< a href = "#development" > Development< / a > |
< a href = "#building" > Building< / a > |
< a href = "#download" > Download< / a > |
< a href = "#support" > Support< / a > |
< a href = "#license" > License< / a >
< / p >
2019-09-21 17:37:21 -04:00
2021-06-24 02:32:41 -04:00
## Compatibility
2014-12-15 20:34:44 -05:00
2021-06-24 02:32:41 -04:00
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 ).
2014-04-08 15:05:45 -04:00
2023-08-04 11:58:49 -04:00
For a full list of games yuzu supports, please visit our [Compatibility page ](https://yuzu-emu.org/game/ ).
2016-02-25 02:42:34 -05:00
2021-06-24 02:32:41 -04:00
Check out our [website ](https://yuzu-emu.org/ ) for the latest news on exciting features, monthly progress reports, and more!
2014-04-08 15:05:45 -04:00
2021-06-24 02:32:41 -04:00
## Development
2014-04-08 15:05:45 -04:00
2021-06-24 02:32:41 -04:00
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 ).
2016-06-21 08:19:46 -04:00
2021-07-24 14:38:22 -04:00
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 ).
2021-06-24 02:32:41 -04:00
You can also contact any of the developers on Discord in order to know about the current state of the emulator.
2014-04-08 15:05:45 -04:00
2021-06-24 02:32:41 -04:00
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.
2020-01-25 18:26:07 -05:00
2021-06-24 02:32:41 -04:00
## Building
2014-04-08 15:05:45 -04:00
2018-01-13 17:28:52 -05:00
* __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 )
2014-12-15 20:01:56 -05:00
2021-06-24 02:32:41 -04:00
## Download
2014-12-15 20:01:56 -05:00
2021-06-24 02:32:41 -04:00
You can download the latest releases automatically via the installer on our [downloads ](https://yuzu-emu.org/downloads/ ) page.
## Support
2021-06-24 02:35:46 -04:00
If you enjoy the project and want to support us financially, check out our Patreon!
2021-06-24 02:32:41 -04:00
< a href = "https://www.patreon.com/yuzuteam" >
< img src = "https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width = "160" >
< / a >
Any donations received will go towards things like:
2018-01-13 17:28:52 -05:00
* 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.)
2021-06-24 02:32:41 -04:00
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
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-14 20:06:02 -04:00
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.
