Skip to content

Commit daf6757

Browse files
committed
doc: add "About" section
The About section is a more comprehensive write-up of the introduction sentences at the very beginning. It should guide the user to know what they can do with this lib.
1 parent e251d03 commit daf6757

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

uefi/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ This crate makes it easy to develop Rust software that leverages **safe**,
1111
![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg)
1212
![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)
1313

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

uefi/src/lib.rs

+13
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@
77
//! important UEFI concepts. For more details of UEFI, see the latest [UEFI
88
//! Specification][spec].
99
//!
10+
//! # About `uefi`
11+
//!
12+
//! With `uefi`, you have the flexibility to integrate selected types and
13+
//! abstractions into your project or to conveniently create EFI images,
14+
//! addressing the entire spectrum of your development needs.
15+
//!
16+
//! `uefi` works with stable Rust, but additional nightly-only features are
17+
//! gated behind an `unstable` Cargo feature flag. Please find more information
18+
//! about supported features below.
19+
//!
20+
//! _Note that for producing EFI images, you also need to use a corresponding
21+
//! `uefi` compiler target of Rust, such as `x86_64-unknown-uefi`._
22+
//!
1023
//! # Interaction with uefi services
1124
//!
1225
//! With this crate you can write code for the pre- and post-exit boot services

0 commit comments

Comments
 (0)