From c666eb8e3fdf5e4d26f8ba11fe3ed1a15bac584b Mon Sep 17 00:00:00 2001 From: Adrian Wannenmacher Date: Sat, 1 Oct 2022 22:15:59 +0200 Subject: [PATCH] update readme --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6517b9b..084934f 100644 --- a/README.md +++ b/README.md @@ -13,20 +13,17 @@ required (though the name remains). ### Prerequisites -This tool expects that you already set up snapper. It also expects that each -snapshots linux and initramfs files (`/boot/vmlinuz-linux` and -`/boot/initramfs-linux.img`) as well as a kernel command line file -(`/etc/snap-pac-uki/kernel-cmd`) are available within each snapshot. +While not depending on it directly, this tool expects that you already set up +snapper. It expects, that each snapshot contains its kernel +(`/boot/vmlinuz-linux`) and initramfs (`/boot/intitramfs-linux.img`), as well as +a kernel command line file (`/etc/snap-pac-uki/kernel-cmd`). -The fallback initramfs (`/boot/initramfs-linux-fallback.img`) and fallback -command line file (`/etc/snap-pac-uki/kernel-cmd-fallback`) are only required -on the current system. +For generating the current and fallback UKIs, the kernel and initramfs files of +the currently running system are used. For a kernel cmd, it uses +`/etc/snap-pac-uki/kernel-cmd-current` and `/etc/snap-pac-uki/kernel-cmd-fallback`. -Also the current command line file (`/etc/snap-pac-uki/kernel-cmd-current`) -needs is only required on the current system. - -EFI boot options are only created for each snapshot. If you want the UKIs -created for the current system, you'll need to add boot entries yourself: +If you want to boot a UKI directly, use the `efibootmgr` command to create an +entry. ```bash # template @@ -56,7 +53,7 @@ efibootmgr -c \ 1. You can install the dependencies of this program with the following command: ```bash - pacman -S fish efibootmgr jq ripgrep sbsigntools sed snapper + pacman -S fish ripgrep sbsigntools sed ``` 2. Download the latest release from [here][releases] and unpack it.