Skip to content

Commit 5c422f8

Browse files
committed
README: clean up formatting
Signed-off-by: James Calligeros <[email protected]>
1 parent 524d9cb commit 5c422f8

1 file changed

Lines changed: 34 additions & 13 deletions

File tree

README.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,50 @@
11
# Asahi Linux installer
2+
The Asahi Linux installer provides a way to install [Asahi Linux](https://asahilinux.org)
3+
on Apple Silicon Macs. These systems have a bespoke [boot process](https://asahilinux.org/docs/platform/introduction/)
4+
that requires special considerations to support [alternative operating systems](https://asahilinux.org/docs/platform/open-os-interop/).
5+
The Asahi Installer takes care of preparing the system for the installation,
6+
downloading an image of the distribution to install and laying it on disk.
27

3-
The Asahi Linux installer provides a way to install [Asahi Linux](https://asahilinux.org) on Apple Silicon Macs. These systems have a bespoke [boot process](https://asahilinux.org/docs/platform/introduction/) that requires special considerations to support [alternative operating systems](https://asahilinux.org/docs/platform/open-os-interop/). The Asahi Installer takes care of preparing the system for the installation, downloading an image of the distribution to install and laying it on disk.
4-
5-
This repository provides the installer itself, supporting scripts, and the `asahi_firmware` Python module (which is also used by [asahi-scripts](https://github.com/AsahiLinux/asahi-scripts)).
8+
This repository provides the installer itself, supporting scripts, and the
9+
`asahi_firmware` Python module (which is also used by [asahi-scripts](https://github.com/AsahiLinux/asahi-scripts)).
610

711
## Building
8-
9-
Run `./build.sh`, which will produce an installer tree under `releases/`. 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. By default, the build will fetch required dependencies from the Internet and cache them under `dl/`. If this isn't desired, place the required files there before running the build.
12+
Run `./build.sh`, which will produce an installer tree under `releases/`. By
13+
default this will build m1n1 with chainloading support. You can optionally set
14+
`M1N1_STAGE1` to a prebuilt m1n1 stage 1 binary, and `LOGO` to a logo in icns format.
15+
These are mostly useful for downstream distributions that would like to customize
16+
or brand the installer. By default, the build will fetch required dependencies from
17+
the Internet and cache them under `dl/`. If this isn't desired, place the required
18+
files there before running the build.
1019

1120
## Bootstrapping and branding
12-
13-
The installer is meant to be executed via a bootstrap script. We provide reference implementations for [local development](scripts/bootstrap.sh) and for alx.sh ([prod](scripts/bootstrap-prod.sh), [dev](scripts/bootstrap-dev.sh)). Following our [distribution guidelines](https://asahilinux.org/docs/alt/policy/), downstream distributions are encouraged to host their own modified copy of these, alongside their downstream build of the installer and their installation images. Downstreams will also want to customize the variable definitions at the beginning of the script, as those will be consumed by the installer and used for its branding. These include:
21+
The installer is meant to be executed via a bootstrap script. We provide reference
22+
implementations for [local development](scripts/bootstrap.sh) and for alx.sh
23+
([prod](scripts/bootstrap-prod.sh), [dev](scripts/bootstrap-dev.sh)). Following
24+
our [distribution guidelines](https://asahilinux.org/docs/alt/policy/), downstream
25+
distributions are encouraged to host their own modified copy of these, alongside
26+
their downstream build of the installer and their installation images. Downstreams
27+
will also want to customize the variable definitions at the beginning of the script,
28+
as those will be consumed by the installer and used for its branding. These include:
1429

1530
* `VERSION_FLAG`: a URI pointing to the `latest` file within the installer tree
1631
* `INSTALLER_BASE`: a URL pointing to your installer tree
17-
* `INSTALLER_DATA`: a URI pointing to your installer medatata file (see [asahi-installer-data](https://github.com/AsahiLinux/asahi-installer) for the one we're using for alx.sh)
18-
* `INSTALLER_DATA_ALT`: optionally, a URI pointing to an alternative location for your installer metadata file; this can be useful in locations where the primary location might be blocked by local network policies
19-
* `REPO_BASE`: a URI pointing to your OS images root (meaning, the parent folder of the relative paths referenced inside the metadata file)
32+
* `INSTALLER_DATA`: a URI pointing to your installer medatata file (see
33+
[asahi-installer-data](https://github.com/AsahiLinux/asahi-installer) for
34+
the one we're using for alx.sh)
35+
* `INSTALLER_DATA_ALT`: optionally, a URI pointing to an alternative location for
36+
your installer metadata file; this can be useful in locations where the
37+
primary location might be blocked by local network policies
38+
* `REPO_BASE`: a URI pointing to your OS images root (meaning, the parent folder
39+
of the relative paths referenced inside the metadata file)
2040
* `REPORT`: a URI pointing to the stats server for installation metrics collection
2141
* `REPORT_TAG`: a string used to identify your distribution for metrics collection
2242

2343
## License
24-
2544
Copyright The Asahi Linux Contributors
2645

27-
The Asahi Linux installer is distributed under the MIT license. See LICENSE for the license text.
46+
The Asahi Linux installer is distributed under the MIT license. See LICENSE for the
47+
license text.
2848

29-
This installer vendors [python-asn1](https://github.com/andrivet/python-asn1), which is distributed under the same license.
49+
This installer vendors [python-asn1](https://github.com/andrivet/python-asn1), which
50+
is distributed under the same license.

0 commit comments

Comments
 (0)