Skip to content

Commit 5c9dc0e

Browse files
committed
doc: unified new TL;DR/description entry
The main idea here is to: - tell that `uefi` is not only for EFI images but also apps that interact with UEFI functionality, such as parsing a memory map from a pre-defined chunk of memory. - streamline the doc
1 parent 1c35ed8 commit 5c9dc0e

File tree

4 files changed

+23
-2
lines changed

4 files changed

+23
-2
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# uefi-rs
22

3+
Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
4+
35
[![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
46
[![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
57
![License](https://img.shields.io/github/license/rust-osdev/uefi-rs)
68
![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg)
79
![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)
810

11+
## TL;DR
12+
13+
Develop Rust software that leverages **safe**, **convenient**, and
14+
**performant** abstractions for [UEFI] functionality.
15+
916
## Description
1017

1118
[UEFI] started as the successor firmware to the BIOS in x86 space and developed

uefi/Cargo.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
name = "uefi"
33
version = "0.29.0"
44
readme = "README.md"
5-
description = "Safe and easy-to-use wrapper for building UEFI apps."
5+
description = """
6+
Develop Rust software that leverages safe, convenient, and performant
7+
abstractions for UEFI functionality.
8+
"""
69

710
authors.workspace = true
811
categories.workspace = true

uefi/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# uefi-rs
1+
# `uefi`
2+
3+
Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
24

35
[![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
46
[![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
57
![License](https://img.shields.io/github/license/rust-osdev/uefi-rs)
68
![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg)
79
![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)
810

11+
## TL;DR
12+
13+
Develop Rust software that leverages **safe**, **convenient**, and
14+
**performant** abstractions for [UEFI] functionality.
915

1016
For an introduction to the `uefi-rs` project and documentation, please refer to
1117
our main [README].

uefi/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
//! Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
22
//!
3+
//! # TL;DR
4+
//!
5+
//! Develop Rust software that leverages **safe**, **convenient**, and
6+
//! **performant** abstractions for [UEFI] functionality.
7+
//!
38
//! See the [Rust UEFI Book] for a tutorial, how-tos, and overviews of some
49
//! important UEFI concepts. For more details of UEFI, see the latest [UEFI
510
//! Specification][spec].

0 commit comments

Comments
 (0)