Add further explanation to the archiso project

This commit is contained in:
Manuel Thalmann 2024-09-30 15:21:09 +02:00
parent ecca742d1a
commit c5762ca86f

View file

@ -1,6 +1,12 @@
# archiso-valhalla # archiso-valhalla
Creates `.iso` files or PXE boot assets for setting up Arch Linux. 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 ## 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. 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 ./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.
<!--- References ---> <!--- References --->
[Nix]: https://nixos.org [Nix]: https://nixos.org