From 4590ffce65bb6aa84179d6fcad448790a180439e Mon Sep 17 00:00:00 2001 From: GreemDev Date: Fri, 14 Mar 2025 17:26:33 -0500 Subject: [PATCH] misc: chore: README overhaul --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 447dda021..a02a100e8 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,13 @@ # Ryujinx - -[![Release workflow](https://github.com/Ryubing/Ryujinx/actions/workflows/release.yml/badge.svg)](https://github.com/Ryubing/Ryujinx/actions/workflows/release.yml) -[![Latest release](https://img.shields.io/github/v/release/Ryubing/Ryujinx)](https://github.com/Ryubing/Ryujinx/releases/latest) -
-[![Canary workflow](https://github.com/Ryubing/Ryujinx/actions/workflows/canary.yml/badge.svg)](https://github.com/Ryubing/Ryujinx/actions/workflows/canary.yml) + +[![Latest release](https://img.shields.io/github/v/release/Ryubing/Stable-Releases?label=stable)](https://github.com/Ryubing/Stable-Releases/releases/latest) [![Latest canary release](https://img.shields.io/github/v/release/Ryubing/Canary-Releases?label=canary)](https://github.com/Ryubing/Canary-Releases/releases/latest) +
+ +Discord + @@ -20,7 +21,7 @@ Ryujinx is an open-source Nintendo Switch emulator, originally created by gdkchan, written in C#. This emulator aims at providing excellent accuracy and performance, a user-friendly interface and consistent builds. It was written from scratch and development on the project began in September 2017. - Ryujinx is available on GitHub under the MIT license. + Ryujinx is available on a self-managed GitLab instance under the MIT license.

@@ -30,21 +31,11 @@
This is not a Ryujinx revival project. This is not a Phoenix project.
- Guides and documentation can be found on the Wiki tab. -

-

- If you would like a more preservative fork of Ryujinx, check out ryujinx-mirror. + Guides and documentation can be found on the Wiki tab.

- Click below to join the Discord: -
- - Discord - -
-
- + Ryujinx example

## Usage @@ -58,7 +49,7 @@ Stable builds are made every so often, based on the `master` branch, that then g These stable builds exist so that the end user can get a more **enjoyable and stable experience**. They are released every month or so, to ensure consistent updates, while not being an annoying amount of individual updates to download over the course of that month. -You can find the latest stable release [here](https://github.com/Ryubing/Ryujinx/releases/latest). +You can find the latest stable release [here](https://github.com/Ryubing/Stable-Releases/releases/latest). Canary builds are compiled automatically for each commit on the `master` branch. While we strive to ensure optimal stability and performance prior to pushing an update, these builds **may be unstable or completely broken**.