summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 18 insertions, 4 deletions
diff --git a/README.md b/README.md
index 554553ee8..b4383606d 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,31 @@
1citra emulator 1Citra Emulator
2============== 2==============
3[![Travis CI Build Status](https://travis-ci.org/citra-emu/citra.svg)](https://travis-ci.org/citra-emu/citra) 3[![Travis CI Build Status](https://travis-ci.org/citra-emu/citra.svg)](https://travis-ci.org/citra-emu/citra)
4 4
5An 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. 5Citra 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. Citra only emulates a subset of 3DS hardware, and therefore is generally only useful for running/debugging homebrew applications. At this time, Citra is even able to boot several commercial games! None of these run to a playable state, but we are working every day to advance the project forward.
6 6
7For development discussion, please join us @ #citra on [freenode](http://webchat.freenode.net/). 7Citra 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.
8
9For development discussion, please join us @ #citra on [freenode](http://webchat.freenode.net/?channels=citra).
8 10
9### Development 11### Development
10 12
11If 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. 13If you want to contribute please take a look 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.
12 14
13### Building 15### Building
14 16
15* __Windows__: [Windows Build](https://github.com/citra-emu/citra/wiki/Windows-Build) 17* __Windows__: [Windows Build](https://github.com/citra-emu/citra/wiki/Windows-Build)
16* __Linux__: [Linux Build](https://github.com/citra-emu/citra/wiki/Linux-Build) 18* __Linux__: [Linux Build](https://github.com/citra-emu/citra/wiki/Linux-Build)
17* __OSX__: [OS X Build](https://github.com/citra-emu/citra/wiki/OS-X-Build) 19* __OSX__: [OS X Build](https://github.com/citra-emu/citra/wiki/OS-X-Build)
20
21
22### Support
23If 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:
24* 3DS consoles for developers to explore the hardware
25* 3DS games for testing
26* Any equipment required for homebrew
27* Infrastructure setup
28* Eventually 3D displays to get proper 3D output working
29* ... etc ...
30
31We 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.