From 5c9693bc31506e32b0050c419825fd682bcad749 Mon Sep 17 00:00:00 2001 From: Yann Dirson Date: Fri, 2 Feb 2024 16:15:27 +0100 Subject: [PATCH] README: better documentation for build requirements --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a60d63..256ef57 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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! \ No newline at end of file +We are seeking to get more contributors. Reviews and feedback welcome!