Skip to content

Commit f3f99cb

Browse files
authored
Improved README.md
1 parent 6b9dc40 commit f3f99cb

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ It uses a sister crate [`efi_ffi`](https://github.com/gurry/efi_ffi) to interfac
2828

2929

3030
## Building the Crate
31-
To build this crate:
31+
32+
To build the crate:
3233
1. Make sure the Rust target `x86_64-unknown-uefi` is installed. If not, install it by running the command `rustup target add x86_64-unknown-uefi`
3334
2. Build the crate by navigating into this repo and running the command `cargo build --target x86_64-unknown-uefi`
3435

@@ -43,14 +44,14 @@ To write a UEFI application using this framework follow the below steps:
4344

4445
```rust
4546
#![no_std] // Indicates to the Rust compiler that the app does not depend on the standard library but is a 'standalone' application.
46-
#![no_main] // Indicates that this application does not have a "main" function typically found in a Linux or Windows application (although it does have its own "main" function "efi_main" as declared below)
47+
#![no_main] // Indicates that this application does not have a standard "main" function typically found in a Linux or Windows application (although it does have its own main function "efi_main")
4748

4849
// Externs for efi and alloc crates (alloc crate is the one that contains definitions of String and Vec etc.)
4950
#[macro_use] extern crate efi;
5051
extern crate alloc;
5152

5253

53-
// EFI entrypoint or main function. UEFI firmware will call this function to start the application.
54+
// EFI entrypoint or main function. UEFI firmware will call it to start the application.
5455
// The signature and the name of this function must be exactly as below.
5556
#[no_mangle]
5657
pub extern "win64" fn efi_main(image_handle: efi::ffi::EFI_HANDLE, sys_table : *const efi::ffi::EFI_SYSTEM_TABLE) -> isize {
@@ -71,6 +72,7 @@ fn panic(_: &core::panic::PanicInfo) -> ! {
7172
```
7273

7374
### Building
75+
7476
Building the application requires the target `x86_64-unknown-uefi` to be installed on your machine. Install it by running `rustup target add x86_64-unknown-uefi` in command shell.
7577

7678
After the target is installed, build the application with the command `cargo build --target x86_64-unknown-uefi`. When the build completes the resulting EFI application `my_efi_app.efi` will be found in `target\x86_64-unknown-uefi\debug\`

0 commit comments

Comments
 (0)