diff --git a/README.md b/README.md index 453e7c77da..f32859aefa 100644 --- a/README.md +++ b/README.md @@ -37,17 +37,28 @@ LibAFL offers integrations with popular instrumentation frameworks. At the momen ## Getting started -1. Install the Rust development language. We highly recommend *not* to use e.g. -your Linux distribution package as this is likely outdated. So rather install +1. Install the Dependecies +- The Rust development language. +We highly recommend *not* to use e.g. your Linux distribition package as this is likely outdated. So rather install Rust directly, instructions can be found [here](https://www.rust-lang.org/tools/install). +- LLVM tools +The LLVM tools are needed (newer than LLVM 11.0.0 but older than LLVM 15.0.0) + +- Cargo-make +We use cargo-make to build the fuzzers in `fuzzers/` directory. You can install it with + +``` +cargo install cargo-make +``` + 2. Clone the LibAFL repository with ``` git clone https://github.com/AFLplusplus/LibAFL ``` -Build the library using +3. Build the library using ``` cargo build --release