Skip to content

Commit fb84058

Browse files
authored
chore(docs): Update docs to mention new protoc requirements in tonic >= 0.8.0 (#1050)
1 parent 9be4e24 commit fb84058

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,31 @@ $ rustup update
5252
$ cargo build
5353
```
5454

55+
### Dependencies
56+
57+
In order to build `tonic` >= 0.8.0, you need the `protoc` Protocol Buffers compiler, along with Protocol Buffers resource files.
58+
59+
#### Ubuntu
60+
61+
```bash
62+
sudo apt update && sudo apt upgrade -y
63+
sudo apt install -y protobuf-compiler libprotobuf-dev
64+
```
65+
66+
#### Alpine Linux
67+
68+
```sh
69+
sudo apk add protoc protobuf-dev
70+
```
71+
72+
#### macOS
73+
74+
Assuming [Homebrew](https://brew.sh/) is already installed. (If not, see instructions for installing Homebrew on [the Homebrew website](https://brew.sh/).)
75+
76+
```zsh
77+
brew install protobuf
78+
```
79+
5580
### Tutorials
5681

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

examples/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,30 @@
22

33
Set of examples that show off the features provided by `tonic`.
44

5+
In order to build these examples, you must have the `protoc` Protocol Buffers compiler
6+
installed, along with the Protocol Buffers resource files.
7+
8+
Ubuntu:
9+
10+
```bash
11+
sudo apt update && sudo apt upgrade -y
12+
sudo apt install -y protobuf-compiler libprotobuf-dev
13+
```
14+
15+
Alpine Linux:
16+
17+
```sh
18+
sudo apk add protoc protobuf-dev
19+
```
20+
21+
macOS:
22+
23+
Assuming [Homebrew](https://brew.sh/) is already installed. (If not, see instructions for installing Homebrew on [the Homebrew website](https://brew.sh/).)
24+
25+
```zsh
26+
brew install protobuf
27+
```
28+
529
## Helloworld
630

731
### Client

0 commit comments

Comments
 (0)