Skip to content

Commit 5217dd0

Browse files
committed
chore(doc): update readme
1 parent b94c684 commit 5217dd0

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,25 @@
66

77
</div>
88

9-
Sprout is an **EXPERIMENTAL** programmable UEFI bootloader written in Rust.
9+
Sprout is a programmable UEFI bootloader written in Rust.
1010

11-
Sprout is in use at Edera today in development environments and is intended to ship to production soon.
11+
It is in use at Edera today in development environments and is intended to ship to production soon.
1212

13-
The name "sprout" is derived from our company name "Edera" which means "ivy."
13+
The name "Sprout" is derived from our company name "Edera" which means "ivy."
1414
Given that Sprout is the first thing intended to start on an Edera system, the name was apt.
1515

1616
It supports `x86_64` and `ARM64` EFI-capable systems. It is designed to require UEFI and can be chainloaded from an
1717
existing UEFI bootloader or booted by the hardware directly.
1818

1919
Sprout is licensed under Apache 2.0 and is open to modifications and contributions.
2020

21-
**IMPORTANT WARNING**: Sprout does not support all of UEFI Secure Boot yet.
22-
See [this issue](https://github.com/edera-dev/sprout/issues/20) for updates.
23-
2421
## Background
2522

2623
At [Edera] we make compute isolation technology for a wide variety of environments, often ones we do not fully control.
27-
Our technology utilizes a hypervisor to boot the host system to provide a new isolation mechanism that works
28-
with or without hardware virtualization support. To do this we need to inject our hypervisor at boot time.
24+
Our technology uses a hypervisor to boot the host system to provide a new isolation mechanism that works
25+
with or without hardware virtualization support. To do this, we need to inject our hypervisor at boot time.
2926

30-
Unfortunately, GRUB, the most common bootloader on Linux systems today, utilizes a shell-script like
27+
Unfortunately, GRUB, the most common bootloader on Linux systems today, uses a shell-script like
3128
configuration system. Both the code that runs to generate a GRUB config and the GRUB config
3229
itself is fully turing complete. This makes modifying boot configuration difficult and error-prone.
3330

@@ -52,8 +49,7 @@ simplify installation and usage.
5249

5350
## Features
5451

55-
NOTE: Currently, Sprout is experimental and is not intended for production use.
56-
The boot menu mechanism is very rudimentary.
52+
**NOTE**: Sprout is still in beta.
5753

5854
### Current
5955

src/autoconfigure/linux.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
use crate::actions::chainload::ChainloadConfiguration;
21
use crate::actions::ActionDeclaration;
2+
use crate::actions::chainload::ChainloadConfiguration;
33
use crate::config::RootConfiguration;
44
use crate::entries::EntryDeclaration;
5-
use crate::generators::list::ListConfiguration;
65
use crate::generators::GeneratorDeclaration;
6+
use crate::generators::list::ListConfiguration;
77
use crate::utils;
88
use anyhow::{Context, Result};
99
use std::collections::BTreeMap;
10+
use uefi::CString16;
1011
use uefi::fs::{FileSystem, Path, PathBuf};
11-
use uefi::proto::device_path::text::{AllowShortcuts, DisplayOnly};
1212
use uefi::proto::device_path::DevicePath;
13-
use uefi::CString16;
13+
use uefi::proto::device_path::text::{AllowShortcuts, DisplayOnly};
1414

1515
/// The name prefix of the Linux chainload action that will be used to boot Linux.
1616
const LINUX_CHAINLOAD_ACTION_PREFIX: &str = "linux-chainload-";

0 commit comments

Comments
 (0)