Skip to content

Commit 6b9dc40

Browse files
authored
Added instructions to build the crate in README.md
1 parent 09d1d52 commit 6b9dc40

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,14 @@ It uses a sister crate [`efi_ffi`](https://github.com/gurry/efi_ffi) to interfac
2424
## Limitations
2525

2626
- Is a work in progress. API surface can change without notice.
27-
- Currently only `x64` architecture is supported.
27+
- Currently only `x64` architecture is supported. In terms of Rust this implies that the crate builds only with the target `x86_64-unknown-uefi`.
28+
29+
30+
## Building the Crate
31+
To build this crate:
32+
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`
33+
2. Build the crate by navigating into this repo and running the command `cargo build --target x86_64-unknown-uefi`
34+
2835

2936
## Writing a UEFI Application
3037

0 commit comments

Comments
 (0)