Skip to content

Commit b605167

Browse files
committed
doc: add minimal example to lib.rs
1 parent d445918 commit b605167

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

uefi/src/lib.rs

+11
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@
77
//! important UEFI concepts. For more details of UEFI, see the latest [UEFI
88
//! Specification][spec].
99
//!
10+
//! # Minimal Example
11+
//!
12+
//! Minimal example for an UEFI application using functionality of the
13+
//! `uefi` crate:
14+
//!
15+
//! ```ignore
16+
#![doc = include_str!("../../template/src/main.rs")]
17+
//! ```
18+
//!
19+
//! Please find more info in our [Rust UEFI Book].
20+
//!
1021
//! # Value-add and Use Cases
1122
//!
1223
//! `uefi` supports writing code for both pre- and post-exit boot services

0 commit comments

Comments
 (0)