Skip to content

Commit 87a727e

Browse files
committed
doc: unified catchy new Crate introduction
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 (cargo.toml, README, lib.rs)
1 parent 79c048a commit 87a727e

File tree

4 files changed

+23
-3
lines changed

4 files changed

+23
-3
lines changed

Diff for: README.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# uefi-rs
22

3+
Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
4+
5+
This crate makes it easy to develop Rust software that leverages **safe**,
6+
**convenient**, and **performant** abstractions for [UEFI] functionality.
7+
38
[![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
49
[![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
510
![License](https://img.shields.io/github/license/rust-osdev/uefi-rs)
@@ -136,3 +141,5 @@ This license allows you to use the crate in proprietary programs, but any
136141
modifications to the files must be open-sourced.
137142

138143
The full text of the license is available in the [license file](LICENSE).
144+
145+
[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface

Diff for: uefi/Cargo.toml

+4-1
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+
This crate makes it easy to develop Rust software that leverages safe,
7+
convenient, and performant abstractions for UEFI functionality.
8+
"""
69

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

Diff for: uefi/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# uefi-rs
1+
# `uefi`
2+
3+
Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
4+
5+
This crate makes it easy to develop Rust software that leverages **safe**,
6+
**convenient**, and **performant** abstractions for [UEFI] functionality.
27

38
[![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
49
[![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
510
![License](https://img.shields.io/github/license/rust-osdev/uefi-rs)
611
![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg)
712
![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)
813

9-
1014
For an introduction to the `uefi-rs` project and documentation, please refer to
1115
our main [README].
1216

@@ -47,3 +51,6 @@ The code in this repository is licensed under the Mozilla Public License 2.
4751
This license allows you to use the crate in proprietary programs, but any modifications to the files must be open-sourced.
4852

4953
The full text of the license is available in the [license file](LICENSE).
54+
55+
56+
[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface

Diff for: uefi/src/lib.rs

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
//! Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
22
//!
3+
//! This crate makes it easy to develop Rust software that leverages **safe**,
4+
//! **convenient**, and **performant** abstractions for [UEFI] functionality.
5+
//!
36
//! See the [Rust UEFI Book] for a tutorial, how-tos, and overviews of some
47
//! important UEFI concepts. For more details of UEFI, see the latest [UEFI
58
//! Specification][spec].

0 commit comments

Comments
 (0)