Skip to content

Commit c9c17af

Browse files
committed
doc: add minimal example to lib.rs
1 parent cae41ba commit c9c17af

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

uefi/src/lib.rs

+15
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@
66
//! See the [Rust UEFI Book] for a tutorial, how-tos, and overviews of some
77
//! important UEFI concepts. For more details of UEFI, see the latest [UEFI
88
//! Specification][spec].
9+
//!
10+
//! # Minimal Example
11+
//!
12+
//! ```ignore
13+
//! #![no_main]
14+
//! #![no_std]
15+
//! use uefi::prelude::*;
16+
//!
17+
//! #[entry]
18+
//! fn main(_image_handle: Handle, _system_table: SystemTable<Boot>) -> Status {
19+
//! uefi::helpers::init().unwrap();
20+
//! println!("Hello world!");
21+
//! Status::SUCCESS
22+
//! }
23+
//! ```
924
//!
1025
//! # Value-add and Use Cases
1126
//!

0 commit comments

Comments
 (0)