yuzu-emu
/
yuzu
Archived
1
0
Fork 0
Code
This repository has been archived on 2024-03-23. You can view files and clone it, but cannot push or open issues or pull requests.
yuzu/README.md

37 lines
2.5 KiB
Markdown
Raw Normal View History

yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
yuzu emulator
=============
yuzu is an experimental open-source emulator for the Nintendo Switch from the creators of [Citra](https://citra-emu.org/).
Update README.md
2016-01-16 07:30:22 +00:00
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
It is written in C++ with portability in mind, with builds actively maintained for Windows, Linux and macOS. The emulator is currently only useful for homebrew development and research purposes.
added Travis CI build indicator to README.md
2014-04-28 16:21:41 +00:00
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
yuzu only emulates a subset of Switch hardware and therefore is generally only useful for running/debugging homebrew applications. At this time, yuzu does not run any commercial Switch games. yuzu can boot some games, to varying degrees of success, but does not implement any of the necessary GPU features to render 3D graphics.
More Readme updates.
2014-12-16 01:34:44 +00:00
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
yuzu is licensed under the GPLv2 (or any later version). Refer to the license.txt file included.
Update README.md
2014-04-08 19:05:45 +00:00
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
Check out our [website](https://yuzu-emu.org/)!
Add website to README. Be proud of it!
2016-02-25 07:42:34 +00:00
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
For development discussion, please join us on [Discord](https://discord.gg/VXqngT3).
Update README.md
2014-04-08 19:05:45 +00:00
### Development
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
Most of the development happens on GitHub. It's also where [our central repository](https://github.com/yuzu-emu/yuzu) is hosted.
Add GPL license.txt and README.md to builds
2016-06-21 12:19:46 +00:00
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
If you want to contribute please take a look at the [Contributor's Guide](CONTRIBUTING.md) and [Developer Information](https://github.com/yuzu-emu/yuzu/wiki/Developer-Information). You should as well contact any of the developers on Discord in order to know about the current state of the emulator.
Update README.md
2014-04-08 19:05:45 +00:00
### Building
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
* __Windows__: [Windows Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Windows)
* __Linux__: [Linux Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Linux)
* __macOS__: [macOS Build](https://github.com/yuzu-emu/yuzu/wiki/Building-for-macOS)
Update README.md
2014-12-16 01:01:56 +00:00
### Support
yuzu: Update README.md.
2018-01-13 22:28:52 +00:00
We happily accept monetary donations or donated games and hardware. Please see our [donations page](https://yuzu-emu.org/donate/) for more information on how you can contribute to yuzu. Any donations received will go towards things like:
* Switch consoles to explore and reverse-engineer the hardware
* Switch games for testing, reverse-engineering, and implementing new features
* Web hosting and infrastructure setup
* Software licenses (e.g. Visual Studio, IDA Pro, etc.)
* Additional hardware (e.g. GPUs as-needed to improve rendering support, other peripherals to add support for, etc.)
We also more than gladly accept used Switch consoles, preferably ones with firmware 3.0.0 or lower! If you would like to give yours away, don't hesitate to join our [Discord](https://discord.gg/VXqngT3) and talk to bunnei. You may also contact: donations@yuzu-emu.org.