1  # Documents Index
 2  
 3  This repo includes several documents that explain both high-level and low-level concepts about Ryujinx and its functions. These are very useful for contributors, to get context that can be very difficult to acquire from just reading code.
 4  
 5  Intro to Ryujinx
 6  ==================
 7  
 8  Ryujinx is an open-source Nintendo Switch emulator, created by gdkchan, written in C#. 
 9  * The CPU emulator, ARMeilleure, emulates an ARMv8 CPU and currently has support for most 64-bit ARMv8 and some of the ARMv7 (and older) instructions.
10  * The GPU emulator emulates the Switch's Maxwell GPU using either the OpenGL (version 4.5 minimum), Vulkan, or Metal (via MoltenVK) APIs through a custom build of OpenTK or Silk.NET respectively.
11  * Audio output is entirely supported via C# wrappers for SDL2, with OpenAL & libsoundio as fallbacks.
12  
13  Getting Started
14  ===============
15  
16  - [Installing the .NET SDK](https://dotnet.microsoft.com/download)
17  - [Official .NET Docs](https://docs.microsoft.com/dotnet/core/)
18  
19  Contributing (Building, testing, benchmarking, profiling, etc.)
20  ===============
21  
22  If you want to contribute a code change to this repo, start here.
23  
24  - [Contributor Guide](../CONTRIBUTING.md)
25  
26  Coding Guidelines
27  =================
28  
29  - [C# coding style](coding-guidelines/coding-style.md)
30  - [Service Implementation Guidelines - WIP](https://gist.github.com/gdkchan/84ba88cd50efbe58d1babfaa7cd7c455)
31  
32  Project Docs
33  =================
34  
35  To be added. Many project files will contain basic XML docs for key functions and classes in the meantime.