Skip to content

Commit

Permalink
doc: clarify protoc requirements (#114)
Browse files Browse the repository at this point in the history
  • Loading branch information
lklimek authored Nov 27, 2024
1 parent 929618d commit 9745cf3
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ The repository contains the following crates:
* [tenderdash-abci](./abci/) - main crate, including ABCI++ socket and tcp server implementation, `Application` trait and re-exporting `tenderdash-proto` crate
* [tenderdash-proto](./proto/) - ABCI++ messages and data types definitions, and gRPC client/server implementation, generated based on Tenderdash protobuf specifications
* [tenderdash-proto-compiler](./proto-compiler/) - an internal tool that fetches tenderdash repository and converts protobuf files to Rust
*

## Version Compatibility

Expand All @@ -31,6 +30,8 @@ This library also includes built-in support for ABCI protocol version verificati
## Quick start

1. Install dependencies. You can find a current list of dependencies in the [Dockerfile](Dockerfile-debian).
* Ensure to install `protoc` from <https://github.com/protocolbuffers/protobuf/releases> and place it in your `$PATH`, as we
**don't support protoc shipped with your distribution** (like Ubuntu).
2. Add tenderdash-abci crate to your project:

```bash
Expand Down

0 comments on commit 9745cf3

Please sign in to comment.