Skip to content

Commit 10204cc

Browse files
docs: update prerequisites to include protobuf native compiler
1 parent 89899c7 commit 10204cc

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

DEVELOPING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ There are a couple components to devtools that you should know about:
88
- `crates/wire` The protobuf files that define the message protocol between the instrumentation and GUI.
99
- `clients/web` The user-facing web GUI that is hosted at `devtools.crabnebula.dev`
1010

11+
## Prerequisites
12+
13+
To compile the project and run tests, you must have the **Protocol Buffers compiler (`protoc`)** installed on your system. This is required by `prost-build` to generate Rust code from the `.proto` files in `crates/wire/proto`.
14+
15+
### Installation
16+
17+
* **macOS**: `brew install protobuf`
18+
* **Ubuntu/Debian**: `sudo apt install -y protobuf-compiler`
19+
* **Windows (Chocolatey)**: `choco install protoc`
20+
* **Other**: Download from [GitHub Releases](https://github.com/protocolbuffers/protobuf/releases)
21+
22+
Ensure `protoc` is in your `PATH`. You can verify by running `protoc --version`.
23+
1124
## The `cargo-deny` check is failing! What do I do?
1225

1326
The [`cargo-deny`](https://github.com/EmbarkStudios/cargo-deny) action checks for various dependency-related issues,

0 commit comments

Comments
 (0)