mirror of
https://github.com/citra-emu/citra.git
synced 2024-11-25 07:10:13 +00:00
Rewrote to link to every page.
parent
61d67cd417
commit
195a2dd400
57
Home.md
57
Home.md
@ -1,18 +1,55 @@
|
||||
Citra – 3DS Emulator
|
||||
Citra – 3DS Emulator and Debugger
|
||||
==============
|
||||
[![Travis CI Build Status](https://travis-ci.org/citra-emu/citra.svg)](https://travis-ci.org/citra-emu/citra)
|
||||
|
||||
An experimental open-source Nintendo 3DS emulator/debugger written in C++. At this time, it only emulates a small subset of 3DS hardware, and therefore is only useful for booting/debugging very simple homebrew demos. Citra is licensed under GPLv2 (or any later version). Refer to the license.txt file included. Please read the [[FAQ]] before getting started with the project.
|
||||
Citra is an experimental open-source Nintendo 3DS emulator/debugger written in C++. Although it is slow at this time, it is constantly being improved.
|
||||
|
||||
For development discussion, please join us at #citra on [freenode](http://webchat.freenode.net/) (irc.freenode.net:6667).
|
||||
|
||||
### Development
|
||||
Citra's features include better visual output, debugging homebrew, with planned controller support.
|
||||
|
||||
The [Citra repositories](https://github.com/citra-emu/citra) are hosted on Github.
|
||||
If you would like to contribute please take a took at the [Contributor's Guide](https://github.com/citra-emu/citra/blob/master/CONTRIBUTING.md), [TODO List](https://docs.google.com/document/d/1SWIop0uBI9IW8VGg97TAtoT_CHNoP42FzYmvG1F4QDA) and [[Developer Information]]. You should as well contact any of the developers on IRC in order to know about the current state of the emulator.
|
||||
Citra is licensed under GPLv2 (or any later version). Refer to the license.txt file included.
|
||||
|
||||
### Building
|
||||
## Usage
|
||||
You may download a precompiled binary from [the website](https://citra-emu.org/), or you can build it yourself.
|
||||
* __[Windows Binary Download](http://builds.citra-emu.org/citra/nightly/citra-latest-windows-amd64.7z)__
|
||||
* [[Build Instructions for Windows|Building For Windows]]
|
||||
* __[Mac OSX Binary Download](http://builds.citra-emu.org/citra/nightly/citra-latest-osx-amd64.tar.xz)__
|
||||
* [[Build Instructions for Mac OSX|Building For OS X]]
|
||||
* __[Linux Binary Download](http://builds.citra-emu.org/citra/nightly/citra-latest-linux-amd64.tar.xz)__
|
||||
* [[Build Instructions for Linux|Building For Linux]]
|
||||
|
||||
* __Windows__: [[Building For Windows]]
|
||||
* __Linux__: [[Building For Linux]]
|
||||
* __OS X__: [[Building For OS X]]
|
||||
Now, you'll need to dump the games you want to play with your 3DS.
|
||||
* [[Dumping Game Cartridges]]
|
||||
|
||||
You can find a reference for Citra's default keyboard bindings here:
|
||||
* [[Default Keyboard Bindings]]
|
||||
|
||||
If you have any questions about Citra, first check these pages:
|
||||
* [[Frequently Asked Questions|FAQ]]
|
||||
* [[Common Issues On Windows|Common Issues]]
|
||||
|
||||
If you don't see your question answered there, feel free to ask at these places:
|
||||
* [Citra's Forums](https://discuss.citra-emu.org/)
|
||||
* The #citra IRC Channel on [freenode](http://webchat.freenode.net/) (irc.freenode.net:6667)
|
||||
* The #citra-dev IRC Channel on [freenode](http://webchat.freenode.net/) (irc.freenode.net:6667)
|
||||
|
||||
## Development
|
||||
|
||||
If you are interested in contributing to Citra's code, the first thing you should read is this guide, which will show you what style to code in:
|
||||
* [Contributing.md](https://github.com/citra-emu/citra/blob/master/CONTRIBUTING.md)
|
||||
|
||||
You can find info about the 3DS on these pages:
|
||||
* [[Developer Information]]
|
||||
* [[CPU Information|CPU]]
|
||||
|
||||
When you are ready, this page will show you how to use Git to setup your own repository:
|
||||
* [[Typical Git Workflow]]
|
||||
|
||||
Using these guides, you can configure Citra to make your life easier:
|
||||
* [[Log Filters]]
|
||||
* [[Home Folder]]
|
||||
|
||||
Now that everything is setup, you can take a look at these places to see what needs to be done:
|
||||
* [TODO List](https://docs.google.com/document/d/1SWIop0uBI9IW8VGg97TAtoT_CHNoP42FzYmvG1F4QDA)
|
||||
* The #citra IRC Channel on [freenode](http://webchat.freenode.net/) (irc.freenode.net:6667)
|
||||
* The #citra-dev IRC Channel on [freenode](http://webchat.freenode.net/) (irc.freenode.net:6667)
|
Loading…
Reference in New Issue
Block a user