From 9745cf3516fb0c57ead44431e64fa9f68b56190e Mon Sep 17 00:00:00 2001 From: lklimek <842586+lklimek@users.noreply.github.com> Date: Wed, 27 Nov 2024 14:03:19 +0100 Subject: [PATCH] doc: clarify protoc requirements (#114) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e9b8b7..c258fea 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 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