Skip to content

Commit 8e174f7

Browse files
committed
doc: move background & trivia info to lib.rs
This is the beginning of moving all relevant information from README.md to lib.rs. The main idea is to have `lib.rs` as main entry point into the documentation instead of an inconsistent mixture between the README and the lib.rs file.
1 parent e76ad8a commit 8e174f7

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,6 @@ This crate makes it easy to develop Rust software that leverages **safe**,
1313

1414
## Description
1515

16-
[UEFI] started as the successor firmware to the BIOS in x86 space and developed
17-
to a universal firmware specification for various platforms, such as ARM. It
18-
provides an early boot environment with a variety of [specified][spec]
19-
ready-to-use "high-level" functionality, such as accessing disks or the network.
20-
EFI images, the files that can be loaded by an UEFI environment, can leverage
21-
these abstractions to extend the functionality in form of additional drivers,
22-
OS-specific bootloaders, or different kind of low-level applications.
23-
2416
Our mission is to provide **safe** and **performant** wrappers for UEFI
2517
interfaces, and allow developers to write idiomatic Rust code.
2618

uefi/src/lib.rs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,20 @@
7474
//! only unfold their potential when you invoke `uefi::helpers::init` as soon
7575
//! as possible in your application.
7676
//!
77+
//! # Trivia and Background
78+
//!
79+
//! [UEFI] started as the successor firmware to the BIOS in x86 space and
80+
//! developed to a universal firmware specification for various platforms, such
81+
//! as ARM. It provides an early boot environment with a variety of
82+
//! [specified][spec] ready-to-use "high-level" functionality, such as accessing
83+
//! disks or the network. EFI images, the files that can be loaded by an UEFI
84+
//! environment, can leverage these abstractions to extend the functionality in
85+
//! form of additional drivers, OS-specific bootloaders, or any different kind
86+
//! of low-level applications.
87+
//!
88+
//! Even joke projects such as an [IRC client][uefirc] leveraging only existing
89+
//! UEFI boot services are possible! 😉
90+
//!
7791
//! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/
7892
//! [UEFI]: https://uefi.org/
7993
//! [`BootServices`]: table::boot::BootServices
@@ -84,6 +98,7 @@
8498
//! [issue tracker]: https://github.com/rust-osdev/uefi-rs/issues
8599
//! [spec]: https://uefi.org/specifications
86100
//! [unstable features]: https://doc.rust-lang.org/unstable-book/
101+
//! [uefirc]: https://github.com/codyd51/uefirc
87102
88103
#![cfg_attr(all(feature = "unstable", feature = "alloc"), feature(allocator_api))]
89104
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

0 commit comments

Comments
 (0)