mirrors/Atmosphere
1
0
Fork 0
mirror of https://github.com/Atmosphere-NX/Atmosphere.git synced 2024-11-18 01:46:47 +00:00
Code Issues Releases Activity
Atmosphere/docs/building.md
tuxuser d42f2e4d1b
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 12:29:17 -08:00

2 KiB
Raw Blame History

Building Atmosphère

Building Atmosphère is a very straightforward process that relies almost exclusively on tools provided by the devkitPro organization.

Dependencies

Instructions

  1. Follow the guide located here 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

  3. Install the following library via python's package manager pip, required by exosphere:

    • lz4

  4. (Optional) In order to build sept the pycryptodome PyPi package is required, which can be installed by running pip install pycryptodome under the installed Python environment of your choice or by installing the complete zip package to support the make dist recipe. This is an optional step included for advanced users who have the ability to provide the necessary encryption/signing keys themselves.

  5. It is, instead, possible to build sept by providing previously encrypted/signed binaries distributed by official Atmosphère release packages. In order to do so, export the following variables in your current environment:

    • SEPT_00_ENC_PATH (must point to the sept-secondary_00.enc file)
    • SEPT_01_ENC_PATH (must point to the sept-secondary_01.enc file)
    • SEPT_DEV_00_ENC_PATH (must point to the sept-secondary_dev_00.enc file)
    • SEPT_DEV_01_ENC_PATH (must point to the sept-secondary_dev_01.enc file)

  6. Finally, clone the Atmosphère repository and run make under its root directory.