Skip to content

Commit

Permalink
Added instructions to build the crate in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gurry authored Aug 18, 2024
1 parent 09d1d52 commit 6b9dc40
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,14 @@ It uses a sister crate [`efi_ffi`](https://github.com/gurry/efi_ffi) to interfac
## Limitations

- Is a work in progress. API surface can change without notice.
- Currently only `x64` architecture is supported.
- Currently only `x64` architecture is supported. In terms of Rust this implies that the crate builds only with the target `x86_64-unknown-uefi`.


## Building the Crate
To build this crate:
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`
2. Build the crate by navigating into this repo and running the command `cargo build --target x86_64-unknown-uefi`


## Writing a UEFI Application

Expand Down

0 comments on commit 6b9dc40

Please sign in to comment.