From e744211edff774c2ad3f9538fd5d2ee67c9dce64 Mon Sep 17 00:00:00 2001 From: Lucio Franco Date: Fri, 29 Jul 2022 14:17:27 -0400 Subject: [PATCH] Update readme for build changes (#689) --- FUZZING.md | 4 ++-- README.md | 11 +++++++---- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/FUZZING.md b/FUZZING.md index d47268d69..b79112d04 100644 --- a/FUZZING.md +++ b/FUZZING.md @@ -11,13 +11,13 @@ To run the afl fuzz tests, first install cargo-afl: Then build a fuzz target and run afl on it: - cd afl// + cd fuzz/afl// cargo afl build --bin fuzz-target cargo afl fuzz -i in -o out target/debug/fuzz-target To reproduce a crash: - cd afl// + cd fuzz/afl// cargo build --bin reproduce cargo run --bin reproduce -- out/crashes/ diff --git a/README.md b/README.md index 27058baa3..e11604496 100644 --- a/README.md +++ b/README.md @@ -56,10 +56,13 @@ possible. ### `protoc` -It's recommended to install `protoc` locally in your path to improve build times. -Prost uses `protoc` to parse protobuf files and will attempt to compile protobuf -from source requiring a C++ toolchain. For more info checkout the [`prost-build`](prost-build) -docs. +With `prost-build` v0.11 release, `protoc` will be required to invoke +`compile_protos` (unless `skip_protoc` is enabled). Prost will no longer provide +bundled a `protoc` or attempt to compile `protoc` for users. For install +instructions for `protoc` please check out the [protobuf install] instructions. + +[protobuf install]: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation + ### Packages