Skip to content

Commit 94e0799

Browse files
committed
doc: add "About" section
The About section is a more comprehensive write-up of the TL;DR section mentioned earlier. It should guide the user to know what they can do with this lib.
1 parent 4faf893 commit 94e0799

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

uefi/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
1313
Develop Rust software that leverages **safe**, **convenient**, and
1414
**performant** abstractions for [UEFI] functionality.
1515

16+
## About
17+
18+
With `uefi`, you have the flexibility to integrate selected types and
19+
abstractions into your project or to conveniently create EFI images, addressing
20+
the entire spectrum of your development needs.
21+
22+
`uefi` works with stable Rust, but additional nightly-only features are
23+
gated behind an `unstable` Cargo feature flag.
24+
25+
_Note that for producing EFI images, you also need to use a corresponding `uefi`
26+
compiler target of Rust, such as `x86_64-unknown-uefi`._
27+
1628
For an introduction to the `uefi-rs` project and documentation, please refer to
1729
our main [README].
1830

uefi/src/lib.rs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@
1616
//! as general information about the project, such as license or MSRV
1717
//! requirements.
1818
//!
19+
//! # About `uefi`
20+
//!
21+
//! With `uefi`, you have the flexibility to integrate selected types and
22+
//! abstractions into your project or to conveniently create EFI images,
23+
//! addressing the entire spectrum of your development needs.
24+
//!
25+
//! `uefi` works with stable Rust, but additional nightly-only features are
26+
//! gated behind an `unstable` Cargo feature flag. Please find more information
27+
//! about supported features below.
28+
//!
29+
//! _Note that for producing EFI images, you also need to use a corresponding
30+
//! `uefi` compiler target of Rust, such as `x86_64-unknown-uefi`._
31+
//!
1932
//! # Interaction with uefi services
2033
//!
2134
//! With this crate you can write code for the pre- and post-exit boot services

0 commit comments

Comments
 (0)