Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme for build changes #689

Merged
merged 1 commit into from Jul 29, 2022
Merged

Update readme for build changes #689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions FUZZING.md
View file
Open in desktop
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
View file
Open in desktop
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