citra-canary/README.md

32 lines
2.3 KiB
Markdown
Raw Normal View History

2014-12-16 01:34:44 +00:00
Citra Emulator
2013-09-26 21:34:48 +00:00
==============
[![Travis CI Build Status](https://travis-ci.org/citra-emu/citra.svg)](https://travis-ci.org/citra-emu/citra)
2014-12-16 01:34:44 +00:00
Citra is an experimental open-source Nintendo 3DS emulator/debugger written in C++. It is written with portability in mind, with builds actively maintained for Windows, Linux and OS X. At this time, it only emulates a subset of 3DS hardware, and therefore is generally only useful for booting/debugging very simple homebrew demos. However, this is changing as more and more progress is being made on running commercial titles, too.
Citra is licensed under the GPLv2. Refer to the license.txt file included. Please read the [FAQ](https://github.com/citra-emu/citra/wiki/FAQ) before getting started with the project.
2014-04-08 19:05:45 +00:00
For development discussion, please join us @ #citra on [freenode](http://webchat.freenode.net/?channels=citra).
2014-04-08 19:05:45 +00:00
### Development
If you want to contribute please take a took at the [Contributor's Guide](CONTRIBUTING.md), [Roadmap](https://github.com/citra-emu/citra/wiki/Roadmap) and [Developer Information](https://github.com/citra-emu/citra/wiki/Developer-Information) pages. You should as well contact any of the developers in the forum in order to know about the current state of the emulator.
2014-04-08 19:05:45 +00:00
### Building
2014-05-20 03:17:08 +00:00
* __Windows__: [Windows Build](https://github.com/citra-emu/citra/wiki/Windows-Build)
* __Linux__: [Linux Build](https://github.com/citra-emu/citra/wiki/Linux-Build)
2014-08-25 23:08:25 +00:00
* __OSX__: [OS X Build](https://github.com/citra-emu/citra/wiki/OS-X-Build)
2014-12-16 01:01:56 +00:00
### Support
If you like, you can [donate by PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=K899FANUJ2ZXW) - any donation received will go towards things like:
2014-12-16 01:30:16 +00:00
* 3DS consoles for developers to explore the hardware
* 3DS games for testing
* Any equipment required for homebrew
* Infrastructure setup
* Eventually 3D displays to get proper 3D output working
* ... etc ...
We also more than gladly accept used 3DS consoles, preferrably ones with firmware 4.5 or lower! If you would like to give yours away, don't hesitate to join our IRC channel #citra on [Freenode](http://webchat.freenode.net/?channels=citra) and talk to neobrain or bunnei. Mind you, IRC is slow-paced, so it might be a while until people reply. If you're in a hurry you can just leave contact details in the channel or via private message and we'll get back to you.