Skip to content

Commit d85b4c9

Browse files
committed
doc: move background 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 27ec946 commit d85b4c9

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,6 @@ Develop Rust software that leverages **safe**, **convenient**, and
1515

1616
## Description
1717

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

uefi/src/lib.rs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,17 @@
8383
//! only unfold their potential when you invoke `uefi::helpers::init` as soon
8484
//! as possible in your application.
8585
//!
86+
//! # Trivia and Background
87+
//!
88+
//! [UEFI] started as the successor firmware to the BIOS in x86 space and
89+
//! developed to a universal firmware specification for various platforms, such
90+
//! as ARM. It provides an early boot environment with a variety of
91+
//! [specified][spec] ready-to-use "high-level" functionality, such as accessing
92+
//! disks or the network. EFI images, the files that can be loaded by an UEFI
93+
//! environment, can leverage these abstractions to extend the functionality in
94+
//! form of additional drivers, OS-specific bootloaders, or any different kind
95+
//! of low-level applications (such as an [IRC client][uefirc]).
96+
//!
8697
//! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/
8798
//! [UEFI]: https://uefi.org/
8899
//! [`BootServices`]: table::boot::BootServices
@@ -93,6 +104,7 @@
93104
//! [issue tracker]: https://github.com/rust-osdev/uefi-rs/issues
94105
//! [spec]: https://uefi.org/specifications
95106
//! [unstable features]: https://doc.rust-lang.org/unstable-book/
107+
//! [uefirc]: https://github.com/codyd51/uefirc
96108
97109
#![cfg_attr(all(feature = "unstable", feature = "alloc"), feature(allocator_api))]
98110
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

0 commit comments

Comments
 (0)