Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Documentation for Asahi Linux Installer #286

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Documentation for Asahi Linux Installer #286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 54 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Asahi Linux installer

TODO: document
The Asahi Linux Installer is designed to facilitate the installation of Asahi Linux on compatible devices. This documentation provides instructions for building, configuring, and deploying the installer, along with licensing information.

## License

Expand All @@ -12,6 +12,57 @@ This installer vendors [python-asn1](https://github.com/andrivet/python-asn1), w

## Building

`./build.sh`
To build the Asahi Linux installer, run the following command:

```sh
./build.sh
```

By default this will build m1n1 with chainloading support. You can optionally set the following environment variables to customize the build:

- `M1N1_STAGE1`: Path to a prebuilt m1n1 stage 1 binary.
- `LOGO`: Path to a logo in ICNS format.

These options are mainly useful for downstream distributions that want to customize or brand the installer.

**Note*** *Before building the Asahi Linux installer, ensure that all submodules are initialized and updated. Run the following commands:*

```sh
git submodule update --init --recursive
```

### Build Script Overview

The `build.sh` script performs several key steps to build the installer:

- Set Environment Variables
- Download Dependencies
- Copies Files & Certificates
- Build m1n1
- Creates a targall of the package and saves it to the releases directory.

## Deployment

To deploy the built installer, use the upload.sh script:

```sh
./upload.sh [prod|dev]
```

prod: Deploys to the production directory.
dev: Deploys to the development directory.


## Testing the Installer

To test the installer, use the following script:

```sh
test.sh
```

## Additional Information

For more details and updates, visit the [Asahi Linux Installer repository](https://github.com/AsahiLinux/asahi-installer).


By default this will build m1n1 with chainloading support. You can optionally set `M1N1_STAGE1` to a prebuilt m1n1 stage 1 binary, and `LOGO` to a logo in icns format. These are mostly useful for downstream distributions that would like to customize or brand the installer.