Add an explanation to the archiso scripts

This commit is contained in:
Manuel Thalmann 2024-06-20 16:58:00 +02:00
parent be33e325fe
commit 9d3e314b53

View file

@ -28,5 +28,31 @@ sudo mkarchiso .
This will generate a `.iso` file in a new folder called `out`. This `.iso` file can be used for installing Arch Linux.
### Updating
This project also contains scripts for updating the files in case Arch Linux's `releng` template (the `archiso` template used by this project) changed.
Said scripts are described briefly in the following chapters.
#### Show Diff
Show the differences between this `archiso` configuration and the `releng` template by running the following command:
```sh
./scripts/show-diff.sh
```
#### Update the Patch
To update the patch containing the differences between Arch Linux's `releng` template and this `archiso` configuration, run this command:
```sh
./scripts/update-patch.sh
```
#### Update the Project
In case Arch Linux did major changes to the `releng` template, it might make sense to replicate these in this `archiso` configuration.
The following command will try to do so using the patch located at `./scripts/valhalla.patch`:
```sh
./scripts/update.sh
```
<!--- References --->
[Nix]: https://nixos.org