Commit Graph

76 Commits

Author SHA1 Message Date
Miisan 14ce83cc8c Update README for clarity and conciseness
This commit improves the readability and understanding of the README file. The changes include simplifying language, removing redundancy, and reorganizing information for better flow. The goal is to make the README more user-friendly, especially for new contributors or users of the yuzu project.
2024-01-10 20:48:50 +08:00
RngValue a09507f271 📝 Update README.md 2023-08-04 17:58:49 +02:00
Minionguyjpro 58c54aecb6 Update README.md (Add Android at builds description) (#10586) 2023-06-03 16:29:26 +02:00
bunnei 2fe922aae5 Update README.md to remove Skyline license exception. 2023-05-10 15:52:30 -07:00
Andrea Pappacoda cdb240f3d4 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 01cf05bc75
2022-07-27 12:53:49 +02:00
Andrea Pappacoda af16f2c6b7 Clarify the Skyline Emulator license exception
`GPL-3.0-or-later OR MPL-2.0` is an SPDX expression: https://spdx.github.io/spdx-spec/SPDX-license-expressions/

Fixes #8219
2022-04-18 10:59:35 +02:00
bunnei 284934ebfd Update project license to GPL v3. 2022-03-24 18:51:23 -07:00
Void48 6d25fe6c9a Update README.md 2021-12-06 11:39:55 +01:00
Fernando Sahmkow e6a0ca5f2c Grant a license exception to Skyline Emulator. 2021-07-25 02:09:42 +02:00
Schplee 5ed87152c3 Fix bold tag 2021-06-23 23:37:03 -07:00
Schplee 373bc6512d Fix typo in Readme 2021-06-23 23:35:46 -07:00
Schplee 496327490f Update Readme 2021-06-23 23:32:41 -07:00
Schplee d1ac25b632 README Edit for EA 2021-02-08 07:46:09 -08:00
JeremyStarTM 5b60899fbc Removed MacOS build link
The MacOS build link was removed in the README.md because it no longer exist.
2021-01-06 11:39:27 +01:00
FearlessTobi 4450a2688a Address trivial review comments. 2020-07-18 14:09:13 +02:00
FearlessTobi 347b50ad43 yuzu: Port translation support from Citra
Co-Authored-By: Weiyi Wang <wwylele@gmail.com>
2020-07-18 14:09:11 +02:00
Morph 63cc4e417f Fix Discord invite link 2020-07-12 10:16:07 -04:00
James Hughes aa41fcc04e Update README.md 2020-03-24 22:30:37 +00:00
James Hughes ac4154bfde Minor ReadMe Changes
Added Discord shield and direct link to contribution guide
2020-03-24 22:26:07 +00:00
Tobias 6af8ff24c9 Update README.md 2020-03-01 18:03:32 +01:00
Ethan 4bd6196b0a Remove AppVeyor status 2019-09-29 22:32:44 +02:00
MysticExile 2b514275ad Update README.md (#2871)
* Update README.md

* Adress feedback

* Add link to our compatability page

* Address feedback

Co-Authored-By: Morph <39850852+Morph1984@users.noreply.github.com>

* Fix spelling

Co-Authored-By: Morph <39850852+Morph1984@users.noreply.github.com>

* Small fix

* Removed the mention of a specific game

* fix
2019-09-21 17:37:21 -04:00
Zach Hilman 12514ccd35 Fix README change mistake (#2754)
Fix README change mistake
2019-07-24 16:42:33 -04:00
Zach Hilman 6738fb5fef Update README.md 2019-07-20 21:03:30 -04:00
Flame Sage 369be67039 Update README.md 2019-07-20 19:24:24 +00:00
Flame Sage aa599ac709 Update README.md 2019-07-20 19:22:30 +00:00
ShalokShalom e9772a2539 Remove outdated info about compability 2019-05-30 05:38:27 +02:00
Nejcraft 90fd257b47 Yuzu can render 3D.
Yuzu can now render 3D graphics to some degree.
2019-03-02 17:23:05 +01:00
jlachniet f600f6eebd Technically, yuzu can boot commercial games
Clarifies the yuzu cannot play commercial games to any reasonable extent, rather than not at all.
2018-04-18 09:18:41 -04:00
bunnei c2e4666579 Update README.md to include AppVeyor build status. 2018-01-16 12:24:15 -05:00
Flame Sage 21f5161ad8 Updated Discord link to match website. 2018-01-16 01:35:04 +00:00
bunnei 2adde6ae8b Update README.md with Travis link. 2018-01-14 21:53:58 -05:00
bunnei 9723c80d93 yuzu: Update README.md. 2018-01-13 17:28:52 -05:00
stone3311 076b395104 Fix info about TODO list 2017-08-26 18:35:45 +02:00
Tiago Morais Morgado 470c6bdca9 fixing a couple of typos 2017-06-28 12:56:10 +01:00
Alex Touchet 1ebe8f4011 Fix FAQ Link in Readme 2017-06-03 20:03:17 -07:00
Christopher J. Gilbert 1db4afd4f4 Removed a linebreak from the README. 2017-03-20 23:48:01 -04:00
Christopher J. Gilbert 07211ecf73 Adding a linebreak to the README file. 2017-03-20 21:27:34 -04:00
Schplee 0bdadea496 New website link updates.
Fixed the broken links that were a result of the updated website.
2017-03-06 08:31:13 -05:00
3dsemu ea67a89d63 Changed FAQ link (#2462)
Changed the FAQ link so it leads to the FAQ on the Citra website, instead of the FAQ hosted
on GitHub
2017-01-23 02:34:50 -03:00
Pringo 83b382a036 Change "OS X" to "macOS" in the Readme 2016-11-14 09:16:11 -08:00
Pringo d7ce7aa527 Link to Donation Page in Readme
Link main site donation page in readme instead of providing further donation info there.
2016-10-31 21:39:42 -07:00
Pringo 6ace08aa0c Update Donation Info in Readme 2016-10-29 09:53:27 -07:00
Ricardo de Almeida Gonzaga 13d46f6820 Fix typos 2016-10-20 12:26:59 -02:00
Yuri Kunde Schlesner 2a910a6d88 README: Specify master branch for Travis CI badge 2016-09-21 02:08:57 -07:00
Jannik Vogel ede028fe4d Add GPL license.txt and README.md to builds 2016-06-21 14:19:46 +02:00
Vitor 544cebd90d Update Building Links
Links on README.md don't exist.
2016-03-03 13:36:18 -03:00
Derek "Turtle" Roe e58ad4ab51 Add website to README. Be proud of it! 2016-02-25 01:42:34 -06:00
Yuri Kunde Schlesner 7b2d034769 Update README.md 2016-01-15 23:30:22 -08:00
Yuri Kunde Schlesner 078bf29d1d Remove webchat link from readme
Hopefully this should reduce the amount of drive-by spam and annoying support requests in the channel.
2015-07-16 20:11:31 -03:00