mirrors/sprout
1
0
Fork 0
mirror of https://github.com/edera-dev/sprout.git synced 2025-12-19 15:40:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): mention autoconfiguration support for bls and use it in the docs

Browse Source
This commit is contained in:
Alex Zenla
2025-10-27 03:52:39 -04:00
parent f60cf4b365
commit fdc5f0e1d2
2 changed files with 13 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -61,6 +61,7 @@ The boot menu mechanism is very rudimentary.
- [x] Windows boot support via chainload - [x] Windows boot support via chainload
- [x] Load Linux initrd from disk - [x] Load Linux initrd from disk
- [x] Basic boot menu - [x] Basic boot menu
- [x] BLS autoconfiguration support
### Roadmap ### Roadmap
@@ -100,6 +101,8 @@ Sprout supports some command line options that can be combined to modify behavio
$ sprout.efi --config=\path\to\config.toml $ sprout.efi --config=\path\to\config.toml
# Boot a specific entry, bypassing the menu. # Boot a specific entry, bypassing the menu.
$ sprout.efi --boot="Boot Xen" $ sprout.efi --boot="Boot Xen"
# Autoconfigure Sprout, without loading a configuration file.
$ sprout.efi --autoconfigure
``` ```
### Boot Linux from ESP ### Boot Linux from ESP
@@ -134,27 +137,11 @@ version = 1
[drivers.ext4] [drivers.ext4]
path = "\\sprout\\drivers\\ext4.efi" path = "\\sprout\\drivers\\ext4.efi"
# extract the full path of the first filesystem # global options.
# that contains \loader as a directory [defaults]
# into the value called "boot" # enable autoconfiguration by detecting bls enabled
[extractors.boot.filesystem-device-match] # filesystems and generating boot entries for them.
has-item = "\\loader" autoconfigure = true
# use the sprout bls module to scan a bls
# directory for entries and load them as boot
# entries in sprout, using the entry template
# as specified here. the bls action below will
# be passed the extracted values from bls.
[generators.boot.bls]
path = "$boot\\loader"
entry.title = "$title"
entry.actions = ["bls"]
# the action that is used for each bls entry above.
[actions.bls]
chainload.path = "$boot\\$chainload"
chainload.options = ["$options"]
chainload.linux-initrd = "$boot\\$initrd"
``` ```
[Edera]: https://edera.dev [Edera]: https://edera.dev

26
docs/fedora-setup.md
View File

@@ -39,27 +39,11 @@ version = 1
[drivers.ext4] [drivers.ext4]
path = "\\sprout\\drivers\\ext4.efi" path = "\\sprout\\drivers\\ext4.efi"
# extract the full path of the first filesystem # global options.
# that contains \loader as a directory [defaults]
# into the value called "boot" # enable autoconfiguration by detecting bls enabled
[extractors.boot.filesystem-device-match] # filesystems and generating boot entries for them.
has-item = "\\loader" autoconfigure = true
# use the sprout bls module to scan a bls
# directory for entries and load them as boot
# entries in sprout, using the entry template
# as specified here. the bls action below will
# be passed the extracted values from bls.
[generators.boot.bls]
path = "$boot\\loader"
entry.title = "$title"
entry.actions = ["bls"]
# the action that is used for each bls entry above.
[actions.bls]
chainload.path = "$boot\\$chainload"
chainload.options = ["$options"]
chainload.linux-initrd = "$boot\\$initrd"
``` ```
## Step 3, Option 1: Configure GRUB to load Sprout (recommended) ## Step 3, Option 1: Configure GRUB to load Sprout (recommended)