summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTranch <tranch.xiao@gmail.com>2026-07-22 17:26:46 +0800
committerGitHub <noreply@github.com>2026-07-22 17:26:46 +0800
commit677aaf3fbbe3f941c1b782980dbc0b422d937027 (patch)
tree8156006e752aa03a910281021ffb5f364927a8d6 /README.md
parent96aac6e87ac41b27383d1839687f391925080007 (diff)
parent5198f735cf5a8c9e8390c2fa2156252c79be72ab (diff)
downloadAeroCore-OS-677aaf3fbbe3f941c1b782980dbc0b422d937027.tar.gz
AeroCore-OS-677aaf3fbbe3f941c1b782980dbc0b422d937027.zip
Merge pull request #2 from AeroCore-IO/testing
Complete AeroCore OS metadata migration and live installer integration
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 33 insertions, 1 deletions
diff --git a/README.md b/README.md
index fdd7c76..3fc11c5 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,25 @@ FROM ghcr.io/ublue-os/bazzite-deck:stable
By focusing strictly on file overlays and configuration writing, this build intentionally avoids invasive operations like `dnf5 install/remove`, COPR enablement, akmods pulls, or kernel recompilations. This architectural choice keeps AeroCore OS completely immune to Fedora/COPR dependency drift during major upstream transition windows (e.g., Bazzite 43 to 44).
+## AeroCore Booster integration
+
+Image builds download the selected AeroCore Booster release from
+`AeroCore-IO/booster-installer`, verify its published SHA-256 checksum, and
+store the complete release seed under `/usr/share/aerocore-booster-release`.
+The release installer runs once for the first active graphical user and copies
+the application into that user's XDG directories. After bootstrapping, updates
+and uninstallation remain owned by the normal Instruments user-space installer.
+The bootstrap completion marker is stored at
+`/var/lib/aerocore/instruments-bootstrap-complete`, so uninstalling the user
+application does not cause the image seed to reinstall it on the next boot.
+Remove that marker and enable `aerocore-instruments-setup.service` to explicitly
+bootstrap the application again.
+
+Set `INSTRUMENTS_VERSION` to a release tag for reproducible builds, or leave it
+as `latest` for rolling development images. Set `INSTRUMENTS_ENABLED=false` to
+build without Booster. The release repository and API base can be overridden
+with `INSTRUMENTS_RELEASE_REPOSITORY` and `INSTRUMENTS_RELEASE_API_BASE`.
+
---
## Key Features & Optimizations
@@ -25,7 +44,7 @@ By focusing strictly on file overlays and configuration writing, this build inte
To build AeroCore OS locally, edit `image-template.env` to match your target configurations and then run:
```bash
-just build
+sudo just build
```
@@ -35,3 +54,16 @@ To test a different upstream base image directly without modifying the environme
BASE_IMAGE=ghcr.io/ublue-os/bazzite-deck:testing just build
```
+
+To build the Bazzite-style live installer locally, first build the AeroCore
+image and then run:
+
+```bash
+sudo just build
+just build-live-installer
+just run-live-installer
+```
+
+This requires privileged Podman, a rootful Podman API socket, and roughly
+70 GiB of free space. The live installer workflow consumes the published
+`latest` AeroCore image and uploads the ISO as a GitHub Actions artifact.