From e090ec8b21d4ecc0293c5546c8b1a12177e7ff2a Mon Sep 17 00:00:00 2001 From: portaldevice Date: Sun, 5 May 2024 09:45:23 +0200 Subject: [PATCH 1/4] Add migration instructions for migrating from yuzu (#178) Co-authored-by: Exverge Signed-off-by: Exverge --- MIGRATION.md | 21 +++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 25 insertions(+) create mode 100644 MIGRATION.md diff --git a/MIGRATION.md b/MIGRATION.md new file mode 100644 index 0000000000..425e301136 --- /dev/null +++ b/MIGRATION.md @@ -0,0 +1,21 @@ +# Migrating from yuzu + +When coming from yuzu, the migration is as easy as renaming some directories. + +## Windows + +Use the run dialog to go to `%APPDATA%` or manually go to `C:\Users\{USERNAME}\AppData\Roaming` (you may have to enable hidden files) and simply rename the `yuzu` directories and simply rename those to `suyu`. + +## Unix (macOS/Linux) +Similarly, you can simply rename the folders `~/.local/share/yuzu` and `~/.config/yuzu` to `suyu`, either via a file manager or with the following commands: +```sh + $ mv ~/.local/share/yuzu ~/.local/share/suyu + $ mv ~/.config/yuzu ~/.config/suyu +``` +There is also `~/.cache/yuzu`, which you can safely delete. Suyu will build a fresh cache in its own directory. + +### Linux +Depending on your setup, you may want to substitute those base paths for `$XDG_DATA_HOME` and `$XDG_CONFIG_HOME` respectively. + +## Android +TBD \ No newline at end of file diff --git a/README.md b/README.md index 54274fa083..f5f968d7ab 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,10 @@ It is written in C++ (C# possibly required soon) with portability in mind, we ac ## Hardware Requirements [Click here to see the Hardware Requirements](https://git.suyu.dev/suyu/suyu/wiki/Hardware-Requirements) +## Migrating from yuzu + +See [MIGRATION.md](MIGRATION.md). + ## Status We currently have builds over at the [Releases](https://git.suyu.dev/suyu/suyu/releases) page. From 99ead7123991ba966be6226ab7b7d41b18ffe918 Mon Sep 17 00:00:00 2001 From: chaphidoesstuff Date: Thu, 2 May 2024 18:11:35 +0200 Subject: [PATCH 2/4] Updated README, fixed links in CONTRIBUTING.md Co-authored-by: Exverge Committed-by: Exverge --- CONTRIBUTING.md | 4 ++-- README.md | 15 +++++++-------- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2bb3f0c76..1ff49d5b1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,5 +6,5 @@ SPDX-License-Identifier: GPL-2.0-or-later Please check out the - * [Contributors's guide](https://gitlab.com/suyu-emu/suyu/-/wikis/Contributing). - * [Merge request guidelines](https://gitlab.com/suyu-emu/suyu/-/wikis/Merge-requests) + * [Contributors's guide](https://git.suyu.dev/suyu/suyu/wiki/Contributing). + * [Merge request guidelines](https://git.suyu.dev/suyu/suyu/wiki/Typical-Git-Workflow#once-your-pull-request-is-ready-to-be-merged) diff --git a/README.md b/README.md index f5f968d7ab..d5f2b29cec 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ SPDX-License-Identifier: GPL-3.0-or-later We're in need of developers. Please join our chat below if you want to contribute! This repo was based on Yuzu EA 4176 but the code is being rewritten from the ground up for legal and performance reasons. -Support the original suyu developer team [here](https://discord.gg/ajz5hdrZ) +Support the original suyu developer team [here](https://discord.gg/79B6wqFPnc)
@@ -23,7 +23,7 @@ Support the original suyu developer team [here](https://discord.gg/ajz5hdrZ)

suyu was the continuation of the world's most popular, open-source Nintendo Switch emulator, yuzu, but is now something more.
-It is written in C++ (C# possibly required soon) with portability in mind, we actively work on builds for Windows, Linux, Android and hopefully IOS, along with a WIP custom OS called suyuOS (https://git.suyu.dev/suyu/suyu-os) . +It is written in C++ with portability in mind, and we actively provide builds for Windows, Linux, Android and iOS potentially coming soon.

@@ -55,10 +55,10 @@ We currently have builds over at the [Releases](https://git.suyu.dev/suyu/suyu/r This project is completely free and open source, and anyone can contribute to help improve suyu. -Most of the development happens on GitLab. For development discussion, please join us in our [Chat](https://chat.suyu.dev). +Most of the development happens on the Git. For development discussion, please join us in our [Chat](https://chat.suyu.dev) or contact a developer. If you want to contribute, please take a look at the [Contributor's Guide](https://git.suyu.dev/suyu/suyu/wiki/Contributing) and [Developer Information](https://git.suyu.dev/suyu/suyu/wiki/Developer-Information). -You can also contact any of the developers on Discord to learn more about the current state of suyu. +You can also contact any of the developers on the Chat to learn more about the current state of suyu. ## Downloads @@ -66,13 +66,12 @@ You can also contact any of the developers on Discord to learn more about the cu * __Linux__: [Releases](https://git.suyu.dev/suyu/suyu/releases) * __macOS__: [Releases](https://git.suyu.dev/suyu/suyu/releases) * __Android__: [Releases](https://git.suyu.dev/suyu/suyu/releases) -* __For IOS users, we recommend Sudachi__: [Releases](https://github.com/emuPlace/Sudachi/releases) +###### We currently do not provide builds for iOS, however if you would like, you could try the experimental [Sudachi](https://github.com/sudachi-emu/sudachi)/Folium. -If you want daily builds then [Click here](https://git.suyu.dev/suyu/suyu/actions) +If you want daily builds then [Click here](https://git.suyu.dev/suyu/suyu/actions). If you don't know how to download the daily builds then [Click here](https://git.suyu.dev/suyu/suyu/raw/branch/dev/img/daily-builds.png) -Right now we only have daily builds for Linux and Android. -We have official builds [here.](https://git.suyu.dev/suyu/suyu/releases) If any website or person is claiming to have a build for suyu, take that with a grain of salt. +We have official builds [here.](https://git.suyu.dev/suyu/suyu/releases)
If any website or person is claiming to have a build for suyu, take that with a grain of salt. ## Building From 2bacc259969bf740ca9499294dceabfa35cdff11 Mon Sep 17 00:00:00 2001 From: chaphidoesstuff Date: Wed, 8 May 2024 10:39:58 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d5f2b29cec..a423a83169 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ SPDX-License-Identifier: GPL-3.0-or-later We're in need of developers. Please join our chat below if you want to contribute! This repo was based on Yuzu EA 4176 but the code is being rewritten from the ground up for legal and performance reasons. -Support the original suyu developer team [here](https://discord.gg/79B6wqFPnc) +Support the original suyu developer team [here](https://discord.gg/79B6wqFPnc).
@@ -66,7 +66,7 @@ You can also contact any of the developers on the Chat to learn more about the c * __Linux__: [Releases](https://git.suyu.dev/suyu/suyu/releases) * __macOS__: [Releases](https://git.suyu.dev/suyu/suyu/releases) * __Android__: [Releases](https://git.suyu.dev/suyu/suyu/releases) -###### We currently do not provide builds for iOS, however if you would like, you could try the experimental [Sudachi](https://github.com/sudachi-emu/sudachi)/Folium. +###### We currently do not provide builds for iOS, however if you would like, you could try the experimental [Sudachi](https://github.com/emuPlace/Sudachi/releases)/[Folium](https://github.com/jarrodnorwell/Folium/releases). If you want daily builds then [Click here](https://git.suyu.dev/suyu/suyu/actions). If you don't know how to download the daily builds then [Click here](https://git.suyu.dev/suyu/suyu/raw/branch/dev/img/daily-builds.png) @@ -84,7 +84,7 @@ We have official builds [here.](https://git.suyu.dev/suyu/suyu/releases)
If a ## Support -If you have any questions, don't hesitate to ask us in our [chat](https://chat.suyu.dev). We don't bite! +If you have any questions, don't hesitate to ask us in our [chat](https://chat.suyu.dev), make an issue or contact a developer. We don't bite! ## License From 93b7854f957cae3697ccf506533f87d9adbceb65 Mon Sep 17 00:00:00 2001 From: administrator Date: Tue, 21 May 2024 02:12:22 +0200 Subject: [PATCH 4/4] Remove unsanctioned Discord invite Having a Discord server linked to Suyu poses a risk to the accounts of its members. Moreover, many of the members of this server have quit the Suyu project and do not wish to continue its development. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index a423a83169..6fa5ed4d2e 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,6 @@ SPDX-License-Identifier: GPL-3.0-or-later We're in need of developers. Please join our chat below if you want to contribute! This repo was based on Yuzu EA 4176 but the code is being rewritten from the ground up for legal and performance reasons. -Support the original suyu developer team [here](https://discord.gg/79B6wqFPnc).