citra-canary/README.md

18 lines
1.4 KiB
Markdown
Raw Normal View History

2013-09-26 21:34:48 +00:00
citra emulator
==============
[![Travis CI Build Status](https://travis-ci.org/citra-emu/citra.svg)](https://travis-ci.org/citra-emu/citra)
2014-08-25 23:08:25 +00:00
An experimental open-source Nintendo 3DS emulator/debugger written in C++. Citra 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. 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/).
### 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)