Skip to content

Commit

Permalink
Update readme for build changes (#689)
Browse files Browse the repository at this point in the history
  • Loading branch information
LucioFranco committed Jul 29, 2022
1 parent 11b5406 commit e744211
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
4 changes: 2 additions & 2 deletions FUZZING.md
Expand Up @@ -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/<target>/
cd fuzz/afl/<target>/
cargo afl build --bin fuzz-target
cargo afl fuzz -i in -o out target/debug/fuzz-target

To reproduce a crash:

cd afl/<target>/
cd fuzz/afl/<target>/
cargo build --bin reproduce
cargo run --bin reproduce -- out/crashes/<crashfile>

Expand Down
11 changes: 7 additions & 4 deletions README.md
Expand Up @@ -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

Expand Down

0 comments on commit e744211

Please sign in to comment.