Atmosphere/README.md


![Banner](img/banner.png?raw=true)
=====

![License](https://img.shields.io/badge/License-GPLv2-blue.svg)

Atmosphère is a work-in-progress customized firmware for the Nintendo Switch.

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.
* 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

Credits
=====

Atmosphère is currently being developed and maintained by __SciresM__, __TuxSH__ and __hexkyz__.<br>
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.tech/) pertaining to the Nintendo Switch.
* __ChaN__ for the [FatFs](http://elm-chan.org/fsw/ff/00index_e.html) module.
* __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.
* __CTCaer__ for the continued [hekate](https://github.com/CTCaer/hekate) project's fork.
* __Riley__ for suggesting "Atmosphere" as a Horizon OS reimplementation+customization project name.
* __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).
* _All those who actively contribute to the Atmosphère repository._
Add license and disclaimer. 2018-01-18 08:38:55 +01:00
Add banner to README 2018-04-27 11:56:06 +02:00			`![Banner](img/banner.png?raw=true)`
Update banner placement in README 2018-04-27 11:56:48 +02:00			`=====`
Add banner to README 2018-04-27 11:56:06 +02:00
Add license and disclaimer. 2018-01-18 08:38:55 +01:00			`![License](https://img.shields.io/badge/License-GPLv2-blue.svg)`

Update README.md 2018-03-30 03:30:58 +02:00			`Atmosphère is a work-in-progress customized firmware for the Nintendo Switch.`
Adding credits section 2018-04-30 18:48:03 +02:00
Add component overview to the readme (#131) 2018-06-08 00:57:09 +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.`
			`* 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`

Adding credits section 2018-04-30 18:48:03 +02:00			`Credits`
			`=====`

Fix credits 2018-06-04 20:31:08 +02:00			`Atmosphère is currently being developed and maintained by __SciresM__, __TuxSH__ and __hexkyz__.<br>`
Adding credits section 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.tech/) pertaining to the Nintendo Switch.`
Fix another critically missing credit 2018-05-06 17:13:04 +02:00			`* __ChaN__ for the [FatFs](http://elm-chan.org/fsw/ff/00index_e.html) module.`
Update README.md 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.`
			`* __CTCaer__ for the continued [hekate](https://github.com/CTCaer/hekate) project's fork.`
Fix critically missing credit 2018-05-06 14:28:34 +02:00			`* __Riley__ for suggesting "Atmosphere" as a Horizon OS reimplementation+customization project name.`
Adding credits section 2018-04-30 18:48:03 +02:00			`* __hedgeberg__ for research and hardware testing.`
			`* __lioncash__ for code cleanup and general improvements.`
Push all graphical resources to main repo, add credits 2018-05-02 02:42:23 +02:00			`* __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).`
Adding credits section 2018-04-30 18:48:03 +02:00			`* _All those who actively contribute to the Atmosphère repository._`