From 92d88fa866303fd206aeff0dd60524b2359c3e63 Mon Sep 17 00:00:00 2001 From: SSimco <37044560+SSimco@users.noreply.github.com> Date: Sat, 30 Aug 2025 14:21:59 +0300 Subject: [PATCH] update readme --- README.md | 54 +++++++----------------------------------------------- 1 file changed, 7 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index c9fe167b..dbec2fdb 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,14 @@ -# **Cemu - Wii U emulator** +# **Cemu - Android Port (Wii U Emulator)** -[![Build Process](https://github.com/cemu-project/Cemu/actions/workflows/build.yml/badge.svg)](https://github.com/cemu-project/Cemu/actions/workflows/build.yml) -[![Discord](https://img.shields.io/discord/286429969104764928?label=Cemu&logo=discord&logoColor=FFFFFF)](https://discord.gg/5psYsup) -[![Matrix Server](https://img.shields.io/matrix/cemu:cemu.info?server_fqdn=matrix.cemu.info&label=cemu:cemu.info&logo=matrix&logoColor=FFFFFF)](https://matrix.to/#/#cemu:cemu.info) +This is the Android port of **Cemu**, a Wii U emulator written in C/C++. +It is still early and experimental. Stability, performance, and features are not guaranteed, and some functionality may be missing compared to the desktop version. -This is the code repository of Cemu, a Wii U emulator that is able to run most Wii U games and homebrew in a playable state. -It's written in C/C++ and is being actively developed with new features and fixes. +There is no timeline for when this port will be finished or when new features will be implemented. -Cemu is currently only available for 64-bit Windows, Linux & macOS devices. +**Please do not open issues or pull requests yet.** +Development is ongoing, and contributions will be welcome once the project is more stable. -### Links: - - [Open Source Announcement](https://www.reddit.com/r/cemu/comments/wwa22c/cemu_20_announcement_linux_builds_opensource_and/) - - [Official Website](https://cemu.info) - - [Compatibility List/Wiki](https://wiki.cemu.info/wiki/Main_Page) - - [Official Subreddit](https://reddit.com/r/Cemu) - - [Official Discord](https://discord.gg/5psYsup) - - [Official Matrix Server](https://matrix.to/#/#cemu:cemu.info) - - [Setup Guide](https://cemu.cfw.guide) - -#### Other relevant repositories: - - [Cemu-Language](https://github.com/cemu-project/Cemu-Language) - - [Cemu's Community Graphic Packs](https://github.com/cemu-project/cemu_graphic_packs) - -## Download - -You can download the latest Cemu releases for Windows, Linux, Mac, and Android from the [GitHub Releases](https://github.com/cemu-project/Cemu/releases/). For Linux you can also find Cemu on [flathub](https://flathub.org/apps/info.cemu.Cemu). - -On Windows Cemu is currently only available in a portable format so no installation is required besides extracting it in a safe place. - -The native macOS build is currently purely experimental and should not be considered stable or ready for issue-free gameplay. There are also known issues with degraded performance due to the use of MoltenVK and Rosetta for ARM Macs. We appreciate your patience while we improve Cemu for macOS. - -Pre-2.0 releases can be found on Cemu's [changelog page](https://cemu.info/changelog.html). - -## Build Instructions - -To compile Cemu yourself on Windows, Linux or macOS, view [BUILD.md](/BUILD.md). - -## Issues - -Issues with the emulator should be filed using [GitHub Issues](https://github.com/cemu-project/Cemu/issues). -The old bug tracker can be found at [bugs.cemu.info](https://bugs.cemu.info) and still contains relevant issues and feature suggestions. - -## Contributing - -Pull requests are very welcome. For easier coordination you can visit the developer discussion channel on [Discord](https://discord.gg/5psYsup) or alternatively the [Matrix Server](https://matrix.to/#/#cemu:cemu.info). -Before submitting a pull request, please read and follow our code style guidelines listed in [CODING_STYLE.md](/CODING_STYLE.md). - -If coding isn't your thing, testing games and making detailed bug reports or updating the (usually outdated) compatibility wiki is also appreciated! - -Questions about Cemu's software architecture can also be answered on Discord (or through the Matrix bridge). +For general information about Cemu, see the [official website](https://cemu.info) and [main repository](https://github.com/cemu-project/Cemu). ## License Cemu is licensed under [Mozilla Public License 2.0](/LICENSE.txt). Exempt from this are all files in the dependencies directory for which the licenses of the original code apply as well as some individual files in the src folder, as specified in those file headers respectively.