Skip to content
This repository was archived by the owner on Mar 7, 2021. It is now read-only.

Commit 521e30c

Browse files
committed
Update README with slightly clearer getting-started instructions
See #110 for why we're requiring rustfmt.
1 parent 2d372cf commit 521e30c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Linux kernel modules in safe Rust
22

3-
1. Install [cargo-xbuild](https://github.com/rust-osdev/cargo-xbuild) and the `rust-src` `rustup` component:
3+
1. Make sure you have Rust installed, as well as [LLVM/Clang 3.9 or higher](https://github.com/rust-lang/rust-bindgen/issues/1316) and kernel headers. Install [cargo-xbuild](https://github.com/rust-osdev/cargo-xbuild) and the `rust-src` and `rustfmt` components for `rustup` component:
44

55
```
6+
apt-get install llvm clang linux-headers-"$(uname -r)" # or the equivalent for your OS
67
cargo install cargo-xbuild
7-
rustup component add --toolchain=nightly rust-src
8+
rustup component add --toolchain=nightly rust-src rustfmt
89
```
910

1011
2. cd to one of the examples

0 commit comments

Comments
 (0)