Skip to content

Commit f880907

Browse files
committed
doc: add "Documentation Structure"
This is logically following the About section.
1 parent 5fd1081 commit f880907

File tree

2 files changed

+10
-17
lines changed

2 files changed

+10
-17
lines changed

uefi/README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,6 @@ This crate's features are described in [`src/lib.rs`].
3636

3737
[`src/lib.rs`]: src/lib.rs
3838

39-
## User Documentation
40-
41-
<!-- KEEP IN SYNC WITH MAIN README -->
42-
43-
For a quick start, please check out [the UEFI application template](template).
44-
45-
The [uefi-rs book] contains a tutorial, how-tos, and overviews of some important
46-
UEFI concepts. Reference documentation for the various crates can be found on
47-
[docs.rs]:
48-
49-
- [docs.rs/uefi](https://docs.rs/uefi)
50-
- [docs.rs/uefi-macros](https://docs.rs/uefi-macros)
51-
- [docs.rs/uefi-raw](https://docs.rs/uefi-raw)
52-
53-
[spec]: http://www.uefi.org/specifications
54-
[uefi-rs book]: https://rust-osdev.github.io/uefi-rs/HEAD
55-
5639
## MSRV
5740

5841
The minimum supported Rust version is currently 1.70.

uefi/src/lib.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,16 @@
5050
//! UEFI support, such as `i686`, `x86_64`, and `aarch64`. Please note that we
5151
//! can't test all possible hardware/firmware/platform combinations in CI.
5252
//!
53+
//! # API/User Documentation, Documentation Structure, and other Resources
54+
//!
55+
//! For a TL;DR quick start with an example on how to create your own EFI
56+
//! application, please check out [the UEFI application template][template]. The
57+
//! [Rust UEFI Book] is a more beginner-friendly tutorial with How-Tos, and
58+
//! overviews of some important UEFI concepts and the abstractions provided by
59+
//! this library.
60+
//!
61+
//! For more details of UEFI itself, see the latest [UEFI Specification][spec].
62+
//!
5363
//! # Crate organisation
5464
//!
5565
//! The top-level module contains some of the most used types and macros,

0 commit comments

Comments
 (0)