From 736d529ea5e9bec45220cc7c8541a92440682d8f Mon Sep 17 00:00:00 2001 From: Crementif <26669564+Crementif@users.noreply.github.com> Date: Tue, 23 Aug 2022 02:37:05 +0200 Subject: [PATCH] Expand readme with links and description --- building.md => BUILD.md | 0 LICENSE => LICENSE.txt | 0 README.md | 51 +++++++++++++++++++++++++++++++++++++++++ readme.md | 29 ----------------------- 4 files changed, 51 insertions(+), 29 deletions(-) rename building.md => BUILD.md (100%) rename LICENSE => LICENSE.txt (100%) create mode 100644 README.md delete mode 100644 readme.md diff --git a/building.md b/BUILD.md similarity index 100% rename from building.md rename to BUILD.md diff --git a/LICENSE b/LICENSE.txt similarity index 100% rename from LICENSE rename to LICENSE.txt diff --git a/README.md b/README.md new file mode 100644 index 00000000..3a4d8a76 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# **Cemu - 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) + + +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 to increase compatibility and usability. + +Cemu is currently only available for 64-bit Windows and Linux devices. + +### Links: + - [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) + - [Unofficial 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/ActualMandM/cemu_graphic_packs) + +## Download + +You can download the latest Cemu releases from the [Github Releases](https://github.com/cemu-project/Cemu/releases/) or from [Cemu's website](http://cemu.info). + +Cemu is currently only available in a portable format so no installation is required besides extracting it in a safe place. + +See [Current State Of Linux builds](https://github.com/cemu-project/Cemu/issues/1) for information on using Cemu natively on Linux. + +Pre-2.0 releases can be found on Cemu's [changelog page](http://cemu.info/changelog.html). + +## Build Instructions + +To compile Cemu yourself for Windows and Linux, view the [BUILD.md file](/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](http://bugs.cemu.info) and might contain useful information. + +## Contributing + +Pull requests are very welcome. For easier coordination you can visit the developer discussion channel on Discord: [https://discord.gg/5psYsup](https://discord.gg/5psYsup). + +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 there. Alternative ways to talk in the Discord are being considered. + +## 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 applies as well as some individual files in the src folder, as specified in those file headers specifically. diff --git a/readme.md b/readme.md deleted file mode 100644 index 50662e69..00000000 --- a/readme.md +++ /dev/null @@ -1,29 +0,0 @@ -# Cemu - Wii U emulator - -This is the official repository for Cemu, a Wii U emulator that runs on x64 Windows and Linux. - -[Official website](https://cemu.info/) - -## Releases - -The latest release is available on the github [releases page](https://github.com/cemu-project/Cemu/releases/) - -Pre-2.0 releases can be found on the [Cemu website](http://cemu.info/changelog.html). - -## Build instructions - -See [building.md](https://github.com/cemu-project/Cemu/blob/master/building.md) - -## State of linux builds - -Linux builds of Cemu are somewhat functional but lack a lot of polish and some features. -Currently we offer prebuilt binaries for ubuntu 20.04. For other distributions you'll have to compile it yourself. In the future we will look into providing appimage and/or flatpak releases. - -**Important: Cemu currently requires all files to be placed in a case-insensitive filesystem** - -## If you want to contribute - -Pull requests are welcome. For easier coordination we invite you to join our developer discussion channel on Discord: [https://discord.gg/5psYsup](https://discord.gg/5psYsup) - -## License -Cemu is licensed under [MPL](https://github.com/cemu-project/cemu/blob/master/LICENSE). Exempt from this are all files in the dependencies directory for which the licenses of the original code applies as well as some individual files in the src folder, as specified in their file headers.