Merge pull request #1284 from phip1611/doc1

doc: unified catchy new Crate introduction [doc: 1/n]

Author: nicholasbishop

Diff for: README.md

@@ -1,5 +1,10 @@
 # uefi-rs
 
+Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
+
+This crate makes it easy to develop Rust software that leverages **safe**,
+**convenient**, and **performant** abstractions for [UEFI] functionality.
+
 [![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
 [![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
 ![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
 modifications to the files must be open-sourced.
 
 The full text of the license is available in the [license file](LICENSE).
+
+[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface

Diff for: uefi/Cargo.toml

@@ -2,7 +2,10 @@
 name = "uefi"
 version = "0.29.0"
 readme = "README.md"
-description = "Safe and easy-to-use wrapper for building UEFI apps."
+description = """
+This crate makes it easy to develop Rust software that leverages safe,
+convenient, and performant abstractions for UEFI functionality.
+"""
 
 authors.workspace = true
 categories.workspace = true
@@ -13,6 +16,7 @@ repository.workspace = true
 rust-version.workspace = true
 
 [features]
+# KEEP this feature list in sync with doc in lib.rs!
 default = [ "log-debugcon" ]
 alloc = []
 

Diff for: uefi/README.md

@@ -1,12 +1,16 @@
-# uefi-rs
+# `uefi`
+
+Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
+
+This crate makes it easy to develop Rust software that leverages **safe**,
+**convenient**, and **performant** abstractions for [UEFI] functionality.
 
 [![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
 [![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
 ![License](https://img.shields.io/github/license/rust-osdev/uefi-rs)
 ![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg)
 ![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)
 
-
 For an introduction to the `uefi-rs` project and documentation, please refer to
 our main [README].
 
@@ -47,3 +51,6 @@ The code in this repository is licensed under the Mozilla Public License 2.
 This license allows you to use the crate in proprietary programs, but any modifications to the files must be open-sourced.
 
 The full text of the license is available in the [license file](LICENSE).
+
+
+[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface

Diff for: uefi/src/lib.rs

@@ -1,5 +1,8 @@
 //! Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
 //!
+//! This crate makes it easy to develop Rust software that leverages **safe**,
+//! **convenient**, and **performant** abstractions for [UEFI] functionality.
+//!
 //! See the [Rust UEFI Book] for a tutorial, how-tos, and overviews of some
 //! important UEFI concepts. For more details of UEFI, see the latest [UEFI
 //! Specification][spec].
@@ -42,7 +45,7 @@
 //! protocol, and see the [`proto`] module for protocol implementations. New
 //! protocols can be defined with the [`unsafe_protocol`] macro.
 //!
-//! ## Optional crate features
+//! ## Optional Cargo crate features
 //!
 //! - `alloc`: Enable functionality requiring the [`alloc`] crate from
 //!   the Rust standard library. For example, methods that return a
@@ -59,8 +62,6 @@
 //!   that prints output to the UEFI console. No buffering is done; this
 //!   is not a high-performance logger.
 //! - `panic_handler`: Add a default panic handler that logs to `stdout`.
-//! - `panic-on-logger-errors` (enabled by default): Panic if a text
-//!   output error occurs in the logger.
 //! - `unstable`: Enable functionality that depends on [unstable
 //!   features] in the nightly compiler.
 //!   As example, in conjunction with the `alloc`-feature, this gate allows