Skip to content

Commit

Permalink
README: better documentation for build requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
ydirson committed Feb 2, 2024
1 parent 5343f69 commit 5c9693b
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,21 @@ Some features to consider (from `xe-guest-utilities`):

## Rust prototype

### Build requirements

You need a Rust toolchain. Some of our dependencies require Rust
1.70 or later.

Since the Cargo tool cannot be told about non-Rust dependencies, you
have to install manually on your build machine:
- packages needed to build a crate linking against a native lib
(`llvm-dev` and `clang` on Debian-based Linux distros)
- development files for libxenstore (package `libxen-dev` on
Debian-based Linux distros, `xen-tools` on FreeBSD)

### How to build

Make sure you have a Rust toolchain available. The base command is simply:
The base command is simply:

```
cargo build
Expand Down Expand Up @@ -183,4 +195,4 @@ We started to investigate a way to also use those tools for Windows guests.

### Getting more contributors

We are seeking to get more contributors. Reviews and feedback welcome!
We are seeking to get more contributors. Reviews and feedback welcome!

0 comments on commit 5c9693b

Please sign in to comment.