Skip to content

doc: massive overhaul of documentation #1264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 13 commits into from
Closed

doc: massive overhaul of documentation #1264

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
79c048a
uefi: remove documentation about already removed feature
phip1611 Jul 28, 2024
676c585
doc: unified new TL;DR/description entry
phip1611 Jul 30, 2024
27ec946
doc: add "About this Document"
phip1611 Jul 30, 2024
d85b4c9
doc: move background info to lib.rs
phip1611 Jul 30, 2024
9f9e5ca
doc: streamline sections Contributing, MSRV, and License
phip1611 Jul 30, 2024
505e70f
doc: add "About" section
phip1611 Jul 30, 2024
e46e74a
doc: extend About section with Example Use Cases
phip1611 Jul 30, 2024
02bc2cf
doc: add Supported Architectures
phip1611 Jul 30, 2024
52954f4
doc: add "Comparison to other Projects in the Ecosystem"
phip1611 Jul 30, 2024
837fe5c
doc: add "API/User Documentation, Documentation Structure, and other …
phip1611 Jul 30, 2024
b9829d7
doc: Crate organization -> Library Structure & Tips
phip1611 Jul 30, 2024
e0fde84
doc: reorder links alphabetically in lib.rs
phip1611 Jul 30, 2024
5c9343f
doc: final streamlining of README files
phip1611 Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,6 @@ Develop Rust software that leverages **safe**, **convenient**, and

## Description

[UEFI] started as the successor firmware to the BIOS in x86 space and developed
to a universal firmware specification for various platforms, such as ARM. It
provides an early boot environment with a variety of [specified][spec]
ready-to-use "high-level" functionality, such as accessing disks or the network.
EFI images, the files that can be loaded by an UEFI environment, can leverage
these abstractions to extend the functionality in form of additional drivers,
OS-specific bootloaders, or different kind of low-level applications.

Our mission is to provide **safe** and **performant** wrappers for UEFI
interfaces, and allow developers to write idiomatic Rust code.

Expand Down
12 changes: 12 additions & 0 deletions uefi/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,17 @@
//! only unfold their potential when you invoke `uefi::helpers::init` as soon
//! as possible in your application.
//!
//! # Trivia and Background
//!
//! [UEFI] started as the successor firmware to the BIOS in x86 space and
//! developed to a universal firmware specification for various platforms, such
//! as ARM. It provides an early boot environment with a variety of
//! [specified][spec] ready-to-use "high-level" functionality, such as accessing
//! disks or the network. EFI images, the files that can be loaded by an UEFI
//! environment, can leverage these abstractions to extend the functionality in
//! form of additional drivers, OS-specific bootloaders, or any different kind
//! of low-level applications (such as an [IRC client][uefirc]).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The IRC client is a neat project, but I'm not sure it makes sense to mention in the readme since it's a pretty niche use case, unlike drivers and bootloaders.

//!
//! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/
//! [UEFI]: https://uefi.org/
//! [`BootServices`]: table::boot::BootServices
Expand All @@ -93,6 +104,7 @@
//! [issue tracker]: https://github.com/rust-osdev/uefi-rs/issues
//! [spec]: https://uefi.org/specifications
//! [unstable features]: https://doc.rust-lang.org/unstable-book/
//! [uefirc]: https://github.com/codyd51/uefirc

#![cfg_attr(all(feature = "unstable", feature = "alloc"), feature(allocator_api))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
Expand Down