From 28e62142e7feb3bfc9c3d6e58440a77bf41f4873 Mon Sep 17 00:00:00 2001 From: Brian Martin Date: Wed, 2 Aug 2023 13:26:25 -0700 Subject: [PATCH] docs: update build instructions in readme (#47) Updates the build instructions in the readme to provide steps for building without BPF support and to clarify some existing language. --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 984a15ac..846a7d3c 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,12 @@ find an answer to, please open a ## Building Rezolus is built using the Rust toolchain. If you do not have the Rust toolchain -installed, please see [rust-lang.org][rust-lang.org] to get -started with Rust. +installed, please see [rust-lang.org][rust-lang.org] to get started with Rust. ### Build Dependencies +Rust >= 1.70.0 + A default build of Rezolus that targets Linux systems will have BPF support enabled by default. For this build, in addition to the rust toolchain, you will need: @@ -70,8 +71,6 @@ need: When building for non-Linux systems or without the default features to disable the `bpf` feature, the only dependencies aside from the rust toolchain are: -To build with eBPF support, the following additional dependencies are required: - * clang >= 11.0 Debian and Ubuntu users can install all the required dependencies for a default @@ -86,12 +85,17 @@ sudo apt install clang libelf-dev make pkg-config * clone this repository or transfer the contents of the repository to your build machine * change directory into the repository root -* run `cargo build` in release mode, optionally enabling the bpf feature +* run `cargo build` in release mode ```bash git clone https://github.com/iopsystems/rezolus cd rezolus -cargo build --release --features bpf +cargo build --release +``` + +**NOTE**: If you want to disable BPF support, you should build Rezolus with: +```bash +cargo build --release --no-default-features ``` ### Configuration