doc: clarify protoc requirements #114
Conversation
WalkthroughThe changes consist of an update to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant README
User->>README: Check Quick Start
README-->>User: Display installation instructions
User->>README: Note `protoc` installation requirement
README-->>User: Clarify unsupported versions
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
README.md (1)
33-34: Enhance the protoc installation instructionsWhile the warning about distribution packages is clear, we could make these instructions more helpful by:
- Specifying the minimum required version of protoc
- Providing direct installation steps
Consider expanding the bullet point like this:
- * 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). + * Install `protoc` (Protocol Buffer Compiler): + 1. Download the latest release from <https://github.com/protocolbuffers/protobuf/releases> + 2. Extract the archive and add the `bin` directory to your `$PATH` + 3. Verify installation: `protoc --version` + + **Note:** Do not use package manager versions (apt, brew, etc.) as they are unsupported.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(1 hunks)
🔇 Additional comments (1)
README.md (1)
33-34: Documentation change looks good!
The added warning about protoc installation:
- Clearly addresses the reported issue with distribution packages
- Is well-placed in the dependencies section
- Correctly emphasizes the PATH requirement
- References the official source for installation
Issue being fixed or feature implemented
protocmust be installed from the github releases page. People try to use protoc from Ubuntu, and fail. Refs #108 #109What was done?
Clarified docs
How Has This Been Tested?
N/A
Breaking Changes
None
Checklist:
For repository code-owners and collaborators only
Summary by CodeRabbit
protocfrom official releases and its inclusion in the user's$PATH.