Add readmes

Dockerfile

@@ -28,7 +28,7 @@ COPY Cargo.toml README.md ./
 COPY libafl_derive/Cargo.toml libafl_derive/Cargo.toml
 COPY scripts/dummy.rs libafl_derive/src/lib.rs
 
-COPY libafl/Cargo.toml libafl/build.rs libafl/
+COPY libafl/Cargo.toml libafl/build.rs libafl/README.md libafl/
 COPY scripts/dummy.rs libafl/src/lib.rs
 
 COPY libafl_bolts/Cargo.toml libafl_bolts/build.rs libafl_bolts/README.md libafl_bolts/

README.md

@@ -45,7 +45,7 @@ We highly recommend *not* to use e.g. your Linux distribition package as this is
 Rust directly, instructions can be found [here](https://www.rust-lang.org/tools/install).
 
 - LLVM tools  
-The LLVM tools (including clang, clang++) are needed (newer than LLVM 11.0.0 but older than LLVM 15.0.0)
+The LLVM tools (including clang, clang++) are needed (newer than LLVM 11.0.0 up to LLVM 17.0.0)
 
 - Cargo-make  
 We use cargo-make to build the fuzzers in `fuzzers/` directory. You can install it with

libafl/README.md

@@ -0,0 +1,6 @@
+# LibAFL Core
+
+LibAFL Core is the main library and contains the fuzzing components and their implementations.
+A large part of this library depends only on Rust core+alloc and, thus, can run without any standard library.
+
+The online documentation for this crate is available [here](https://docs.rs/crate/libafl/latest).

libafl_cc/Cargo.toml

@@ -5,7 +5,7 @@ authors = ["Andrea Fioraldi <[email protected]>"]
 description = "Commodity library to wrap compilers and link LibAFL"
 documentation = "https://docs.rs/libafl_cc"
 repository = "https://github.com/AFLplusplus/LibAFL/"
-readme = "../README.md"
+readme = "README.md"
 license = "MIT OR Apache-2.0"
 keywords = ["fuzzing", "testing", "compiler"]
 edition = "2021"

libafl_cc/README.md

@@ -0,0 +1,8 @@
+# LibAFL CC
+
+LibAFL CC provides the functionalities to write compiler wrappers for LibAFL, by providing to the user a set of compiler extensions useful for instrumentation.
+
+The online documentation for this crate is available [here](https://docs.rs/crate/libafl_cc/latest).
+
+Currently, we support LLVM version 11 up to 18, but other versions may work.
+To install LLVM, use the official [download page](https://releases.llvm.org/download.html).