Update readme

This commit is contained in:
Aurora 2016-09-06 16:41:37 +02:00
parent d3d315784c
commit 144de8b328

View File

@ -1,23 +1,37 @@
# Luma3DS
*Noob-proof (N)3DS "Custom Firmware"*
**Compiling:**
## What it is
First you need to clone the repository recursively with: `git clone --recursive https://github.com/AuroraWright/Luma3DS.git`
**Luma3DS** is a program to patch the system software of (New) Nintendo 3DS handheld consoles "on the fly", adding features (such as per-game language settings and debugging capabilities for developers) and removing restrictions enforced by Nintendo (such as the region lock).
It also allows you to run unauthorized ("homebrew") content by removing signature checks.
To use it, you will need a console capable of running homebrew software on the ARM9 processor. We recommend [Plailect's guide](https://github.com/Plailect/Guide/wiki) for details on how to get your system ready.
---
## Compiling
First you need to clone the repository recursively with: `git clone --recursive https://github.com/AuroraWright/Luma3DS.git`
To compile, you'll need [armips](https://github.com/Kingcom/armips), [bin2c](https://sourceforge.net/projects/bin2c/), and a recent build of [makerom](https://github.com/profi200/Project_CTR) added to your PATH.
For your convenience, here are [Windows](http://www91.zippyshare.com/v/ePGpjk9r/file.html) and [Linux](https://mega.nz/#!uQ1T1IAD!Q91O0e12LXKiaXh_YjXD3D5m8_W3FuMI-hEa6KVMRDQ) builds of armips (thanks to who compiled them!).
Finally just run `make` and everything should work!
You can find the compiled files in the 'out' folder.
You can find the compiled files in the `out` folder.
**Setup / Usage / Features:**
---
## Setup / Usage / Features
See https://github.com/AuroraWright/Luma3DS/wiki
**Credits:**
---
## Credits
See https://github.com/AuroraWright/Luma3DS/wiki/Credits
**Licensing:**
---
## Licensing
This software is licensed under the terms of the GPLv3.
You can find a copy of the license in the LICENSE.txt file.