From c5762ca86fc6859d1c1a5b41982b1986256332f3 Mon Sep 17 00:00:00 2001 From: Manuel Thalmann Date: Mon, 30 Sep 2024 15:21:09 +0200 Subject: [PATCH] Add further explanation to the `archiso` project --- archiso/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/archiso/README.md b/archiso/README.md index aa33afe5..f322ff33 100644 --- a/archiso/README.md +++ b/archiso/README.md @@ -1,6 +1,12 @@ # archiso-valhalla Creates `.iso` files or PXE boot assets for setting up Arch Linux. +`.iso` files created using this project will contain a copy of this repository +including the current uncommitted or untracked changes. + +When booting the resulting `.iso` file, the Arch Linux setup will automatically start +using the `scripts/Arch/OS/setup.fish` script in this repository. + ## Usage This project is meant to be used on Arch Linux. However, configuration files are provided to use it on any Linux system (or WSL) with [Nix] installed. @@ -56,5 +62,10 @@ The following command will try to do so using the patch located at `./scripts/va ./scripts/update.fish ``` +### Booting the `.iso` File +The `.iso` file can be booted like any other `.iso` file (by writing it on a USB stick, burning it on a DVD or attaching it to a VM). + +Most notably, `.iso` files created using this project will also work with USB thumbsticks with Ventoy installed. + [Nix]: https://nixos.org