From 660a2df4549dacd9e671f23cdf092a1f1b817d45 Mon Sep 17 00:00:00 2001 From: Alex Zenla Date: Sat, 26 Sep 2026 20:26:57 -0700 Subject: [PATCH] docs(setup): fix step headings and the name of the downloaded file The Ubuntu guide repeated the Step 7 heading, and the Windows guide went from Step 1 to Step 3. The guides also said to download sprout-.efi, then to copy the downloaded sprout.efi file, which doesn't exist under that name. --- docs/setup/signed/debian.md | 2 +- docs/setup/signed/fedora.md | 2 +- docs/setup/signed/ubuntu.md | 4 +--- docs/setup/unsigned/alpine-edge.md | 2 +- docs/setup/unsigned/fedora.md | 2 +- docs/setup/unsigned/generic-linux.md | 2 +- docs/setup/unsigned/windows.md | 6 +++--- 7 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/setup/signed/debian.md b/docs/setup/signed/debian.md index e887cf4..76333b8 100644 --- a/docs/setup/signed/debian.md +++ b/docs/setup/signed/debian.md @@ -55,7 +55,7 @@ $ cp /usr/lib/shim/fbaa64.efi.signed /boot/efi/EFI/sprout/fbaa64.efi Download the latest sprout.efi release from the [GitHub releases page](https://github.com/edera-dev/sprout/releases). For x86_64 systems, download the `sprout-x86_64.efi` file, and for ARM64 systems, download the `sprout-aarch64.efi` file. -Copy the downloaded `sprout.efi` file to `/boot/efi/EFI/sprout/sprout.unsigned.efi` on your EFI System Partition. +Copy the downloaded file to `/boot/efi/EFI/sprout/sprout.unsigned.efi` on your EFI System Partition. ## Step 4: Sign Sprout for Secure Boot diff --git a/docs/setup/signed/fedora.md b/docs/setup/signed/fedora.md index 5f13251..20a5233 100644 --- a/docs/setup/signed/fedora.md +++ b/docs/setup/signed/fedora.md @@ -55,7 +55,7 @@ $ cp /boot/efi/EFI/fedora/mmaa64.efi /boot/efi/EFI/sprout/mmaa64.efi Download the latest sprout.efi release from the [GitHub releases page](https://github.com/edera-dev/sprout/releases). For x86_64 systems, download the `sprout-x86_64.efi` file, and for ARM64 systems, download the `sprout-aarch64.efi` file. -Copy the downloaded `sprout.efi` file to `/boot/efi/EFI/sprout/sprout.unsigned.efi` on your EFI System Partition. +Copy the downloaded file to `/boot/efi/EFI/sprout/sprout.unsigned.efi` on your EFI System Partition. ## Step 4: Sign Sprout for Secure Boot diff --git a/docs/setup/signed/ubuntu.md b/docs/setup/signed/ubuntu.md index 0f526b6..71b49a1 100644 --- a/docs/setup/signed/ubuntu.md +++ b/docs/setup/signed/ubuntu.md @@ -54,7 +54,7 @@ $ cp /usr/lib/shim/fbaa64.efi /boot/efi/EFI/sprout/fbaa64.efi Download the latest sprout.efi release from the [GitHub releases page](https://github.com/edera-dev/sprout/releases). For x86_64 systems, download the `sprout-x86_64.efi` file, and for ARM64 systems, download the `sprout-aarch64.efi` file. -Copy the downloaded `sprout.efi` file to `/boot/efi/EFI/sprout/sprout.unsigned.efi` on your EFI System Partition. +Copy the downloaded file to `/boot/efi/EFI/sprout/sprout.unsigned.efi` on your EFI System Partition. ## Step 4: Sign Sprout for Secure Boot @@ -129,8 +129,6 @@ If you do not have any drivers, exclude the drivers section entirely. ## Step 7: Configure Sprout Boot Entry -## Step 7: Configure Sprout Boot Entry - In the following commands, replace /dev/BLOCK_DEVICE with the device that houses your GPT partition table, and PARTITION_NUMBER with the partition number of the EFI System Partition. For example, if your EFI System Partition is `/dev/sda1`, the BLOCK_DEVICE would be `/dev/sda` and the PARTITION_NUMBER would be `1` diff --git a/docs/setup/unsigned/alpine-edge.md b/docs/setup/unsigned/alpine-edge.md index d4ac805..2e65475 100644 --- a/docs/setup/unsigned/alpine-edge.md +++ b/docs/setup/unsigned/alpine-edge.md @@ -10,7 +10,7 @@ Download the latest sprout.efi release from the [GitHub releases page](https://github.com/edera-dev/sprout/releases). For x86_64 systems, download the `sprout-x86_64.efi` file, and for ARM systems, download the `sprout-aarch64.efi` file. -Copy the downloaded `sprout.efi` file to `/boot/efi/EFI/boot/sprout.efi` on your EFI System Partition. +Copy the downloaded file to `/boot/efi/EFI/boot/sprout.efi` on your EFI System Partition. Additionally, you will want to install the `efifs` package, which provides the filesystem support for Sprout. diff --git a/docs/setup/unsigned/fedora.md b/docs/setup/unsigned/fedora.md index 0f19af5..021dc7c 100644 --- a/docs/setup/unsigned/fedora.md +++ b/docs/setup/unsigned/fedora.md @@ -10,7 +10,7 @@ Download the latest sprout.efi release from the [GitHub releases page](https://github.com/edera-dev/sprout/releases). For x86_64 systems, download the `sprout-x86_64.efi` file, and for ARM systems, download the `sprout-aarch64.efi` file. -Copy the downloaded `sprout.efi` file to `/boot/efi/EFI/BOOT/sprout.efi` on your EFI System Partition. +Copy the downloaded file to `/boot/efi/EFI/BOOT/sprout.efi` on your EFI System Partition. Additionally, you will want to install the `edk2-ext4` package, which provides the ext4 filesystem support for Sprout. diff --git a/docs/setup/unsigned/generic-linux.md b/docs/setup/unsigned/generic-linux.md index 88dd0a4..0bbec66 100644 --- a/docs/setup/unsigned/generic-linux.md +++ b/docs/setup/unsigned/generic-linux.md @@ -12,7 +12,7 @@ First, identify the path to your EFI System Partition. On most systems, this is Download the latest sprout.efi release from the [GitHub releases page](https://github.com/edera-dev/sprout/releases). For x86_64 systems, download the `sprout-x86_64.efi` file, and for ARM systems, download the `sprout-aarch64.efi` file. -Copy the downloaded `sprout.efi` file to `/EFI/BOOT/sprout.efi` on your EFI System Partition. +Copy the downloaded file to `/EFI/BOOT/sprout.efi` on your EFI System Partition. ## Step 2: Copy kernel and optional initramfs diff --git a/docs/setup/unsigned/windows.md b/docs/setup/unsigned/windows.md index e7617a8..78d7b9a 100644 --- a/docs/setup/unsigned/windows.md +++ b/docs/setup/unsigned/windows.md @@ -23,9 +23,9 @@ Standard editors can, however, be used to edit files on the ESP. Download the latest sprout.efi release from the [GitHub releases page](https://github.com/edera-dev/sprout/releases). For x86_64 systems, download the `sprout-x86_64.efi` file, and for ARM systems, download the `sprout-aarch64.efi` file. -Copy the downloaded `sprout.efi` file to `X:\EFI\BOOT\sprout.efi` on your EFI System Partition. +Copy the downloaded file to `X:\EFI\BOOT\sprout.efi` on your EFI System Partition. -## Step 3: Configure Sprout +## Step 2: Configure Sprout Write the following file to `X:\sprout.toml`: @@ -39,7 +39,7 @@ version = 1 autoconfigure = true ``` -## Step 4: Configure EFI Firmware to boot Sprout +## Step 3: Configure EFI Firmware to boot Sprout It is not trivial to add an EFI boot entry inside Windows. However, most firmware lets you load arbitrary EFI files from the firmware settings.