Reword README.md
This commit is contained in:
parent
36df6d6a98
commit
35a7ca25b1
52
README.md
52
README.md
@ -1,36 +1,40 @@
|
|||||||
# Luma3DS
|
# Luma3DS
|
||||||
*Noob-proof (N)3DS "Custom Firmware"*
|
|
||||||
|
|
||||||
### What it is
|
*Nintendo 3DS "Custom Firmware"*
|
||||||
**Luma3DS** is a program to patch the system software of (New) Nintendo (2)3DS handheld consoles "on the fly", adding features such as per-game language settings, 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.
|
## What it is
|
||||||
To use it, you will need a console capable of running homebrew software on the Arm9 processor.
|
**Luma3DS** is a program patching and reimplementing significant parts of the software running on all models of the Nintendo 3DS family of consoles.
|
||||||
|
|
||||||
Since v8.0, Luma3DS has its own in-game menu, triggerable by <kbd>L+Down+Select</kbd> (see the [release notes](https://github.com/LumaTeam/Luma3DS/releases/tag/v8.0)).
|
It aims at greatly improving the user experience and at supporting the 3DS far beyond its end-of-life. Features include:
|
||||||
|
|
||||||
#
|
* First class support of 3DSX homebrew
|
||||||
### Compiling
|
* An overlay menu called "Rosalina" (triggerable by <kbd>L+Down+Select</kbd> by default), allowing amongst many thing to take screenshots while in-game
|
||||||
* Prerequisites
|
* Removal of restrictions such as the region lock
|
||||||
1. git
|
* Per-game language settings, asset content path redirection (LayeredFS), game plugins...
|
||||||
2. [makerom](https://github.com/jakcron/Project_CTR) in PATH
|
* A fully-fledged GDB stub allowing to debug software (homebrew and system software alike)
|
||||||
3. [firmtool](https://github.com/TuxSH/firmtool)
|
* ... and much more!
|
||||||
4. Up-to-date devkitARM+libctru
|
|
||||||
1. Clone the repository with `git clone https://github.com/LumaTeam/Luma3DS.git`
|
|
||||||
2. Run `make`.
|
|
||||||
|
|
||||||
The produced `boot.firm` is meant to be copied to the root of your SD card for usage with Boot9Strap.
|
Luma3DS requires a full-system persisent exploit such as [boot9strap](https://github.com/SciresM/boot9strap) to run.
|
||||||
|
|
||||||
#
|
## Compiling
|
||||||
### Setup / Usage / Features
|
|
||||||
See https://github.com/LumaTeam/Luma3DS/wiki
|
|
||||||
|
|
||||||
#
|
To build Luma3DS, the following is needed:
|
||||||
### Credits
|
* git
|
||||||
See https://github.com/LumaTeam/Luma3DS/wiki/Credits
|
* up-to-date devkitARM and libctru
|
||||||
|
* [makerom](https://github.com/jakcron/Project_CTR) in PATH
|
||||||
|
* [firmtool](https://github.com/TuxSH/firmtool) installed
|
||||||
|
|
||||||
#
|
The produced `boot.firm` is meant to be copied to the root of your SD card for usage with Boot9Strap.
|
||||||
### Licensing
|
|
||||||
|
## Setup / Usage / Features
|
||||||
|
See https://github.com/LumaTeam/Luma3DS/wiki (needs rework)
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
See https://github.com/LumaTeam/Luma3DS/wiki/Credits (needs rework)
|
||||||
|
|
||||||
|
## Licensing
|
||||||
This software is licensed under the terms of the GPLv3. You can find a copy of the license in the LICENSE.txt file.
|
This software is licensed under the terms of the GPLv3. You can find a copy of the license in the LICENSE.txt file.
|
||||||
|
|
||||||
Files in the GDB stub are instead triple-licensed as MIT or "GPLv2 or any later version", in which case it's specified in the file header.
|
Files in the GDB stub are instead triple-licensed as MIT or "GPLv2 or any later version", in which case it's specified in the file header.
|
||||||
|
|
||||||
|
By contributing to this repository, you agree to license your changes to the project's owners.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user