Skip to content

Commit

Permalink
docs: update readme to call out bugged LLVM 18 versions (#169)
Browse files Browse the repository at this point in the history
Signed-off-by: Melvin Wang <[email protected]>
  • Loading branch information
wmmc88 authored May 30, 2024
1 parent 793a270 commit b5fb26f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ This project was built with support of WDM, KMDF, and UMDF drivers in mind, as w
### Build Requirements

* Binding generation via `bindgen` requires `libclang`. The easiest way to acquire this is via `winget`
* `winget install -i LLVM.LLVM`
* Ensure you select the GUI option to add LLVM to the PATH
* `winget install -i LLVM.LLVM --version 17.0.6 --force`
* Ensure you select the GUI option to add LLVM to the PATH
* LLVM 18 has a bug that causes bindings to fail to generate for ARM64. Continue using LLVM 17 until LLVM 19 comes out with [the fix](https://github.com/llvm/llvm-project/pull/93235). See [this](https://github.com/rust-lang/rust-bindgen/issues/2842) for more details.
* To execute post-build tasks (ie. `inf2cat`, `infverif`, etc.), `cargo make` is used
* `cargo install --locked cargo-make --no-default-features --features tls-native`

Expand Down

0 comments on commit b5fb26f

Please sign in to comment.