forked from cemu-project/Cemu
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expand readme with links and description
- Loading branch information
Showing
4 changed files
with
51 additions
and
29 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# **Cemu - Wii U emulator** | ||
|
||
[](https://github.com/cemu-project/Cemu/actions/workflows/build.yml) | ||
[](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. |