chore(docs): Update docs to mention new protoc requirements in tonic >= 0.8.0 (#1050)

2022-08-09 18:31:03 +02:00
parent 9be4e2479d
commit fb840583d3
2 changed files with 49 additions and 0 deletions
@@ -52,6 +52,31 @@ $ rustup update
 $ cargo build
 ```

+### Dependencies
+
+In order to build `tonic` >= 0.8.0, you need the `protoc` Protocol Buffers compiler, along with Protocol Buffers resource files.
+
+#### Ubuntu
+
+```bash
+sudo apt update && sudo apt upgrade -y
+sudo apt install -y protobuf-compiler libprotobuf-dev
+```
+
+#### Alpine Linux
+
+```sh
+sudo apk add protoc protobuf-dev
+```
+
+#### macOS
+
+Assuming [Homebrew](https://brew.sh/) is already installed. (If not, see instructions for installing Homebrew on [the Homebrew website](https://brew.sh/).)
+
+```zsh
+brew install protobuf
+```
+
 ### Tutorials

 - The [`helloworld`][helloworld-tutorial] tutorial provides a basic example of using `tonic`, perfect for first time users!