citra/README.md
2014-04-28 17:07:48 -04:00

16 lines
1.2 KiB
Markdown

citra emulator
==============
[![Travis CI Build Status](https://travis-ci.org/bunnei/citra.svg)](https://travis-ci.org/bunnei/citra)
An experimental open-source Nintendo 3DS emulator/debugger written in C++. At this time, it only emulates a very small subset of 3DS hardware, and therefore is 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/bunnei/citra/wiki/FAQ) before getting started with the project.
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 [Coding Style](https://github.com/bunnei/citra/wiki/Coding-Style), [Roadmap](https://github.com/bunnei/citra/wiki/Roadmap) and [Developer Information](https://github.com/bunnei/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.
### Building
* __Windows__: [Windows Build](https://github.com/bunnei/citra/wiki/Windows-Build)
* __Linux__: [Linux Build](https://github.com/bunnei/citra/wiki/Linux-Build)