Skip to content

Commit

Permalink
docs: update build instructions in readme (#47)
Browse files Browse the repository at this point in the history
Updates the build instructions in the readme to provide steps for
building without BPF support and to clarify some existing language.
  • Loading branch information
brayniac authored Aug 2, 2023
1 parent 12d5353 commit 28e6214
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 28e6214

Please sign in to comment.