aboutsummaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Correct project name in license sectionDjihads4 days1-1/+1
|
* Modify supported platforms in READMEDjihads4 days1-1/+1
| | | Updated the README to reflect supported platforms.
* Remove packaging status badge from READMEDjihads4 days1-2/+0
| | | Removed packaging status badge from README.
* Revise README with updated links and informationDjihads4 days1-29/+9
| | | Updated Discord links, modified compatibility information, and changed download and donation sections.
* Rename project to Eglantine and enhance READMEDjihads6 days1-20/+25
| | | Updated project name from 'Eden' to 'Eglantine' and revised related descriptions. Added development section and updated support information.
* [docs] Various grammar fixes, fix dead links, update deps.md, merge RDOC ↵lizzie2026-09-011-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | into Debug.md (#4315) Signed-off-by: lizzie <lizzie@eden-emu.dev> - [x] I have read and followed the [Contribution Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/CONTRIBUTING.md#code-contributions). - [x] I have read and followed the [AI Policy](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/AI.md) - [x] I have read and followed the [Coding Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/Coding.md) to the best of my ability. ------------------- updates deps.md (freebsd had a package that didnt exist, oops) netbsd also had outdated packages moved windows caveats into the user guide (because well, those are user stuff, not build caveats) MANY redundant wording removals (especially on dynarmic) proper capitalization of Eden, Dynarmic, Amiibo, and CLion fixed discord link on metainfo as well also fixed file associations as well otherwise installed eden wont have icon over NSP/XCI/etc files "please" is filler fixes a HANDFUL of dead links as well Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/4315 Reviewed-by: crueter <crueter@eden-emu.dev> Reviewed-by: CamilleLaVey <camillelavey99@gmail.com>
* [docs] overview doc for newcomers (#4266)lizzie2026-08-181-2/+17
| | | | | | | | | | | | | | | | Signed-off-by: lizzie <lizzie@eden-emu.dev> - [x] I have read and followed the [Contribution Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/CONTRIBUTING.md#code-contributions). - [x] I have read and followed the [AI Policy](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/AI.md) - [x] I have read and followed the [Coding Guidelines](https://git.eden-emu.dev/eden-emu/eden/src/branch/master/docs/policies/Coding.md) to the best of my ability. ------------------- documents basic stuff about the emu and "hey eden is HLE" (like most yuzu forks!) Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/4266 Reviewed-by: CamilleLaVey <camillelavey99@gmail.com> Reviewed-by: Maufeat <sahyno1996@gmail.com>
* [docs] Tighten AI restrictions and switch to CONTRIBUTING.md (#4193)crueter2026-07-091-23/+3
| | | | | | | | | Also removes some now-unnecessary docs files. Signed-off-by: crueter <crueter@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/4193 Reviewed-by: MaranBr <maranbr@eden-emu.dev> Reviewed-by: Lizzie <lizzie@eden-emu.dev>
* [docs] Obtanium, installing mods, external ES-DE config, section about CFW ↵lizzie2026-03-071-1/+7
| | | | | | | | | | | and settings (#3678) Signed-off-by: lizzie <lizzie@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/3678 Reviewed-by: DraVee <chimera@dravee.dev> Reviewed-by: CamilleLaVey <camillelavey99@gmail.com> Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
* [dist] New 2026 Saint Patrick's icon; drop named variants (#3617)lizzie2026-02-231-1/+1
| | | | | | | | | Signed-off-by: lizzie <lizzie@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/3617 Reviewed-by: MaranBr <maranbr@eden-emu.dev> Reviewed-by: CamilleLaVey <camillelavey99@gmail.com> Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
* [meta] remove UTF8-hyphen on readme, rewrite to be more neutral (#3273)lizzie2026-01-091-2/+2
| | | | | | | | | Signed-off-by: lizzie <lizzie@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/3273 Reviewed-by: DraVee <dravee@eden-emu.dev> Reviewed-by: CamilleLaVey <camillelavey99@gmail.com> Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
* [dist, docs] Revolt renames itself to Stoat, change rvlt.gg to stt.gg (#2656)Lizzie2025-12-171-5/+5
| | | | | | | | | | | | | No badges.io yet, no new SVG logo from them Signed-off-by: lizzie <lizzie@eden-emu.dev> Co-authored-by: Maufeat <sahyno1996@gmail.com> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2656 Reviewed-by: Maufeat <sahyno1996@gmail.com> Reviewed-by: Caio Oliveira <caiooliveirafarias0@gmail.com> Co-authored-by: Lizzie <lizzie@eden-emu.dev> Co-committed-by: Lizzie <lizzie@eden-emu.dev>
* [meta] remove stale/dead links in help/about (#3064)lizzie2025-11-221-4/+4
| | | | | | | | | | | | removes old links to dead wiki Signed-off-by: lizzie lizzie@eden-emu.dev Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/3064 Reviewed-by: crueter <crueter@eden-emu.dev> Reviewed-by: MaranBr <maranbr@eden-emu.dev> Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
* [docs] add packaging status to README (#2658)lizzie2025-10-051-0/+2
| | | | | | | | | | | | Very surprising we are on repology already. Anyways this may help power users track which packages are outdated and whatnot wrt to others. Signed-off-by: lizzie <lizzie@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2658 Reviewed-by: MaranBr <maranbr@eden-emu.dev> Reviewed-by: crueter <crueter@eden-emu.dev> Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
* [tools, cmake] refactor: update/hash check scripts, use tags for some more ↵crueter2025-10-051-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | deps, proper CPMUtil separation (#2666) Uses tags for a bunch of deps that can use them Also adds a bunmch of scripts to tools/cpm, notably for checking hashes and checking for updates. TODO for the future: - CI target to check hashes - Weekly CI to check for updates Need to get that other CI runner up additional stuff - Ports gentoo fixes - makes solaris work (TODO: sdl2) - way better docs - properly separates CPMUtil as a standalone project Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2666 Reviewed-by: Lizzie <lizzie@eden-emu.dev> Reviewed-by: MaranBr <maranbr@eden-emu.dev>
* [cmake] feat: FFmpeg CI, allow 16kb android builds, update translations for ↵crueter2025-09-231-0/+2
| | | | | | | | | | | | | | | | transifex (#2543) Uses an FFmpeg CI for Android and Windows, also available for Linux. Saves compile time on Linux and is more consistent on Windows/Android. Also, updates VVL and FFmpeg to allow for a fully 16kb-compliant Android build. Bonus: APK size is down 30% Updated all localization files for Transifex while I was at it TODO for future: Android 8.0 with vp9_vulkan et al. Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2543 Reviewed-by: Maufeat <sahyno1996@gmail.com> Reviewed-by: Lizzie <lizzie@eden-emu.dev>
* [docs] signup instructions (#2542)crueter2025-09-211-0/+2
| | | | | Signed-off-by: crueter <crueter@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2542
* [docs] refactor: full rewrite, generalization + dedup (#488)crueter2025-09-181-7/+1
| | | | | | | | | | | | | | | "docs but awesome" Combines most of the stuff that was repeated thrice over verbatim into a single common Build Instructions page, with additional caveats marked elsewhere. Prettifies some stuff too because why not. cc: @Lizzie @DraVee @MaranBr @SDK-Chan Co-authored-by: Caio Oliveira <caiooliveirafarias0@gmail.com> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/488 Reviewed-by: Lizzie <lizzie@eden-emu.dev> Reviewed-by: MaranBr <maranbr@eden-emu.dev>
* [compat] openbsd port fixes (#273)lizzie2025-09-081-0/+1
| | | | | | | | | Signed-off-by: lizzie <lizzie@eden-emu.dev> Co-authored-by: crueter <crueter@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/273 Reviewed-by: crueter <crueter@eden-emu.dev> Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
* [Frontend] add X links to About and Help (#272)Bix2025-08-161-0/+1
| | | | | | | | | | | Based off the recent addition of revolt links. Authored-by: Bix bix@bixed.xyz Signed-off-by: Bix bix@bixed.xyz Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/272 Reviewed-by: crueter <crueter@eden-emu.dev> Co-authored-by: Bix <bix@bixed.xyz> Co-committed-by: Bix <bix@bixed.xyz>
* revolt (#213)crueter2025-08-071-3/+6
| | | | | | Signed-off-by: crueter <crueter@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/213 Reviewed-by: Lizzie <lizzie@eden-emu.dev>
* [meta] readme updates (#206)crueter2025-08-061-2/+2
| | | | | | Signed-off-by: crueter <crueter@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/206 Reviewed-by: Lizzie <lizzie@eden-emu.dev>
* [android, ci] disable workflows, update ERF desc, default flush_lines to on ↵crueter2025-07-261-3/+2
| | | | | | | | (#132) title says it all Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/132
* [docs] add solaris to build inst on readme (#105)lizzie2025-07-231-0/+1
| | | | | | Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/105 Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
* [docs] add into docs/ and make links local (#93)lizzie2025-07-231-6/+8
| | | | | | | Co-authored-by: crueter <crueter@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/93 Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
* Update linkscrueter2025-07-091-6/+5
| | | | Signed-off-by: crueter <crueter@eden-emu.dev>
* Test pushcrueter2025-07-061-2/+3
| | | | Signed-off-by: crueter <swurl@swurl.xyz>
* update discord linkcrueter2025-07-061-1/+1
| | | | Signed-off-by: crueter <swurl@swurl.xyz>
* [cmake] Update URL to new repoBix2025-07-051-2/+2
|
* Update README.mdJPikachu2025-05-101-3/+7
| | | Signed-off-by: JPikachu <jpikachu.eden@gmail.com>
* update translate (#100)swurl2025-05-101-1/+1
| | | | | | | Co-authored-by: Pavel Barabanov <pavelbarabanov94@gmail.com> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/100 Co-authored-by: swurl <swurl@swurl.xyz> Co-committed-by: swurl <swurl@swurl.xyz>
* ui/overlay: Fix enhanced frame pacing naming and disable frameskip for now. ↵swurl2025-05-101-8/+6
| | | | | | (#99) Signed-off-by: swurl <swurl@swurl.xyz>
* updated build guide links (#60)swurl2025-04-261-3/+3
| | | | Signed-off-by: swurl <swurl@swurl.xyz>
* Some slight changes to the readme. (#59)Bix2025-04-261-22/+18
| | | | | | | | | | | | | | Just a small fix to the readme, I tested it by the way. Fixed "Levey" to "LaVey" Made shortened words complete. Declared Language. Used "en-gb" complaint Language. Signed-off-by: Bix <xq9zp7f2@proton.me> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/59 Co-authored-by: Bix <xq9zp7f2@proton.me> Co-committed-by: Bix <xq9zp7f2@proton.me>
* Update README.mdJPikachu2025-04-131-3/+2
| | | | Add named logo and remove Yuzu fully
* Update README.mdJPikachu2025-04-121-1/+1
| | | | (again)
* Update README.mdJPikachu2025-04-121-25/+23
|
* 📝 Update README.mdRngValue2023-08-041-1/+1
|
* Update README.md (Add Android at builds description) (#10586)Minionguyjpro2023-06-031-1/+1
|
* Update README.md to remove Skyline license exception.bunnei2023-05-101-2/+0
|
* chore: make yuzu REUSE compliantAndrea Pappacoda2022-07-271-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [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 b2eb10382941bef0914f4a0a4685b9033440aa9f
* Clarify the Skyline Emulator license exceptionAndrea Pappacoda2022-04-181-1/+1
| | | | | `GPL-3.0-or-later OR MPL-2.0` is an SPDX expression: https://spdx.github.io/spdx-spec/SPDX-license-expressions/ Fixes #8219
* Update project license to GPL v3.bunnei2022-03-241-2/+2
|
* Update README.mdVoid482021-12-061-1/+1
|
* Grant a license exception to Skyline Emulator.Fernando Sahmkow2021-07-251-2/+4
|
* Fix bold tagSchplee2021-06-231-1/+1
|
* Fix typo in ReadmeSchplee2021-06-231-1/+1
|
* Update ReadmeSchplee2021-06-231-20/+57
|
* README Edit for EASchplee2021-02-081-1/+1
|
* Removed MacOS build linkJeremyStarTM2021-01-061-1/+0
| | | The MacOS build link was removed in the README.md because it no longer exist.