summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorbunnei <ericbunnie@gmail.com>2014-04-08 21:05:45 +0200
committerbunnei <ericbunnie@gmail.com>2014-04-08 21:05:45 +0200
commit7a7917df27cfe5c342bba6c15b57d389fce585bd (patch)
treea9a96ec2a64cdef9f806358f50c9f1d4e2419b33 /README.md
parentMerge branch 'hardware-interface' (diff)
downloadyuzu-7a7917df27cfe5c342bba6c15b57d389fce585bd.tar
yuzu-7a7917df27cfe5c342bba6c15b57d389fce585bd.tar.gz
yuzu-7a7917df27cfe5c342bba6c15b57d389fce585bd.tar.bz2
yuzu-7a7917df27cfe5c342bba6c15b57d389fce585bd.tar.lz
yuzu-7a7917df27cfe5c342bba6c15b57d389fce585bd.tar.xz
yuzu-7a7917df27cfe5c342bba6c15b57d389fce585bd.tar.zst
yuzu-7a7917df27cfe5c342bba6c15b57d389fce585bd.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6271f93c5..8210eb989 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
citra emulator
==============
+An 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.
+
+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__: Install *Visual Studio 2013*. Then open the *.SLN* file, and press *Build* > *Rebuild Solution*.
+* __Linux__: *TODO*