Atmosphere/docs/building.md

# Building Atmosphère
Building Atmosphère is a very straightforward process that relies almost exclusively on tools provided by the [devkitPro](https://devkitpro.org) organization.

## Dependencies
+ [devkitA64](https://devkitpro.org)
+ [devkitARM](https://devkitpro.org)
+ [Python 2](https://www.python.org) (Python 3 may work as well, but this is not guaranteed)
+ [LZ4](https://pypi.org/project/lz4)
+ [PyCryptodome](https://pypi.org/project/pycryptodome) (optional)
+ [hactool](https://github.com/SciresM/hactool)

## Instructions
1. Follow the guide located [here](https://devkitpro.org/wiki/Getting_Started) to install and configure all the tools necessary for the build process.

2. Install the following packages via (dkp-)pacman:
    + `switch-dev`
    + `switch-glm`
    + `switch-libjpeg-turbo`
    + `devkitARM`
    + `devkitarm-rules`
    + `hactool`

3. Install the following library via python's package manager `pip`, required by [exosphere](components/exosphere.md):
    + `lz4`

4. Finally, clone the Atmosphère repository and run `make` under its root directory.
Create Documentation/Wiki Various changes suggested by misson20000 2018-09-23 19:53:32 -04:00			`# Building Atmosphère`
docs: initial re-write of all documentation 2020-04-26 14:06:59 -04:00			`Building Atmosphère is a very straightforward process that relies almost exclusively on tools provided by the [devkitPro](https://devkitpro.org) organization.`
Create Documentation/Wiki Various changes suggested by misson20000 2018-09-23 19:53:32 -04:00
docs: initial re-write of all documentation 2020-04-26 14:06:59 -04:00			`## Dependencies`
			`+ [devkitA64](https://devkitpro.org)`
			`+ [devkitARM](https://devkitpro.org)`
Note that we are a python 2 project. 2020-10-09 20:37:51 -04:00			`+ [Python 2](https://www.python.org) (Python 3 may work as well, but this is not guaranteed)`
Add lz4 dependency to the build instructions (#1308) * Add lz4 dependency to the build instructions At build-time of exosphere, the `split_program.py` script is called. It requires python module `lz4` -> https://github.com/Atmosphere-NX/Atmosphere/blob/master/exosphere/program/split_program.py Adding lz4 to the building.md documentation. * Remove "(Python Library)" from deps-entries 2020-12-31 15:29:17 -05:00			`+ [LZ4](https://pypi.org/project/lz4)`
docs: address review commentary 2020-04-27 13:40:22 -04:00			`+ [PyCryptodome](https://pypi.org/project/pycryptodome) (optional)`
docs: add hactool to list of build dependencies (#1662) Co-authored-by: ndeadly <24677491+ndeadly@users.noreply.github.com> 2021-10-10 07:50:57 -04:00			`+ [hactool](https://github.com/SciresM/hactool)`
Create Documentation/Wiki Various changes suggested by misson20000 2018-09-23 19:53:32 -04:00
docs: initial re-write of all documentation 2020-04-26 14:06:59 -04:00			`## Instructions`
docs: wipe sept from the docs 2021-08-20 16:17:11 -04:00			`1. Follow the guide located [here](https://devkitpro.org/wiki/Getting_Started) to install and configure all the tools necessary for the build process.`
Add additional dependency information (#495) - individually listed packages required when using (dkp-)packman. - added sept dependencies - added requirement to use -r flag - added recommendation for zip (for use if someone wants to make dist) 2019-04-01 20:35:10 -04:00
docs: address review commentary 2020-04-27 13:40:22 -04:00			`2. Install the following packages via (dkp-)pacman:`
docs: minor style fix 2020-04-27 13:52:53 -04:00			+ `switch-dev`
docs/building: missing required lib glm 2020-11-24 01:59:52 -05:00			+ `switch-glm`
docs: minor style fix 2020-04-27 13:52:53 -04:00			+ `switch-libjpeg-turbo`
			+ `devkitARM`
			+ `devkitarm-rules`
docs: add hactool to list of build dependencies (#1662) Co-authored-by: ndeadly <24677491+ndeadly@users.noreply.github.com> 2021-10-10 07:50:57 -04:00			+ `hactool`
docs: initial re-write of all documentation 2020-04-26 14:06:59 -04:00
Add lz4 dependency to the build instructions (#1308) * Add lz4 dependency to the build instructions At build-time of exosphere, the `split_program.py` script is called. It requires python module `lz4` -> https://github.com/Atmosphere-NX/Atmosphere/blob/master/exosphere/program/split_program.py Adding lz4 to the building.md documentation. * Remove "(Python Library)" from deps-entries 2020-12-31 15:29:17 -05:00			3. Install the following library via python's package manager `pip`, required by [exosphere](components/exosphere.md):
			+ `lz4`
docs: initial re-write of all documentation 2020-04-26 14:06:59 -04:00
docs: wipe sept from the docs 2021-08-20 16:17:11 -04:00			4. Finally, clone the Atmosphère repository and run `make` under its root directory.