Atmosphere/README.md

52 lines
3.2 KiB
Markdown
Raw Normal View History

2018-01-18 08:38:55 +01:00
2018-04-27 11:56:06 +02:00
![Banner](img/banner.png?raw=true)
2018-04-27 11:56:48 +02:00
=====
2018-04-27 11:56:06 +02:00
2018-01-18 08:38:55 +01:00
![License](https://img.shields.io/badge/License-GPLv2-blue.svg)
2024-03-20 08:56:08 +01:00
[![Chat on Discord](https://img.shields.io/badge/Discord-5865f2?logo=discord&logoColor=white)](https://discordapp.com/invite/ZdqEhed)
2018-01-18 08:38:55 +01:00
2018-03-30 03:30:58 +02:00
Atmosphère is a work-in-progress customized firmware for the Nintendo Switch.
2018-04-30 18:48:03 +02:00
Components
=====
Atmosphère consists of multiple components, each of which replaces/modifies a different component of the system:
* Fusée: First-stage Loader, responsible for loading and validating stage 2 (custom TrustZone) plus package2 (Kernel/FIRM sysmodules), and patching them as needed. This replaces all functionality normally in Package1loader/NX Bootloader.
* Sept: Payload used to enable support for runtime key derivation on 7.0.0.
* Exosphère: Customized TrustZone, to run a customized Secure Monitor
* Thermosphère: EL2 EmuNAND support, i.e. backing up and using virtualized/redirected NAND images
* Stratosphère: Custom Sysmodule(s), both Rosalina style to extend the kernel/provide new features, and of the loader reimplementation style to hook important system actions
* Troposphère: Application-level Horizon OS patches, used to implement desirable CFW features
2019-05-31 03:20:24 +02:00
Licensing
=====
This software is licensed under the terms of the GPLv2, with exemptions for specific projects noted below.
You can find a copy of the license in the [LICENSE file](LICENSE).
Exemptions:
2020-02-25 05:47:11 +01:00
* [Nintendo](https://github.com/Nintendo) is exempt from GPLv2 licensing and may (at its option) instead license any source code authored for the Atmosphère project under the Zero-Clause BSD license.
2019-05-31 03:20:24 +02:00
2018-04-30 18:48:03 +02:00
Credits
=====
Atmosphère is currently being developed and maintained by __SciresM__, __TuxSH__, __hexkyz__, and __fincs__.<br>
2018-04-30 18:48:03 +02:00
In no particular order, we credit the following for their invaluable contributions:
* __switchbrew__ for the [libnx](https://github.com/switchbrew/libnx) project and the extensive [documentation, research and tool development](http://switchbrew.org) pertaining to the Nintendo Switch.
* __devkitPro__ for the [devkitA64](https://devkitpro.org/) toolchain and libnx support.
* __ReSwitched Team__ for additional [documentation, research and tool development](https://reswitched.github.io/) pertaining to the Nintendo Switch.
2018-05-06 17:13:04 +02:00
* __ChaN__ for the [FatFs](http://elm-chan.org/fsw/ff/00index_e.html) module.
2018-08-18 19:15:23 +02:00
* __Marcus Geelnard__ for the [bcl-1.2.0](https://sourceforge.net/projects/bcl/files/bcl/bcl-1.2.0) library.
* __naehrwert__ and __st4rk__ for the original [hekate](https://github.com/nwert/hekate) project and its hwinit code base.
2018-11-12 02:56:33 +01:00
* __CTCaer__ for the continued [hekate](https://github.com/CTCaer/hekate) project's fork and the [minerva_tc](https://github.com/CTCaer/minerva_tc) project.
2019-06-16 01:28:18 +02:00
* __m4xw__ for development of the [emuMMC](https://github.com/m4xw/emummc) project.
2018-05-06 14:28:34 +02:00
* __Riley__ for suggesting "Atmosphere" as a Horizon OS reimplementation+customization project name.
2018-04-30 18:48:03 +02:00
* __hedgeberg__ for research and hardware testing.
* __lioncash__ for code cleanup and general improvements.
* __jaames__ for designing and providing Atmosphère's graphical resources.
* Everyone who submitted entries for Atmosphère's [splash design contest](https://github.com/Atmosphere-NX/Atmosphere-splashes).
2018-04-30 18:48:03 +02:00
* _All those who actively contribute to the Atmosphère repository._