Skip to content

Add README.md to google-protobuf-codegen release crate #29536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Sep 1, 2026
+23 −0
Merged

Add README.md to google-protobuf-codegen release crate #29536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions rust/release_crates/google_protobuf_codegen/Cargo-template.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[package]
name = "google-protobuf-codegen"
readme = "README.md"
version = "{PROTOBUF_RUST_VERSION}"
edition = "2021"
license = "BSD-3-Clause"
Expand Down
22 changes: 22 additions & 0 deletions rust/release_crates/google_protobuf_codegen/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The build time dependency crate for generating code for the official Google Rust
Protobuf implementation.

The code generated by this is expected to be used in conjunction with the
official [Protobuf crate](http://crates.io/crates/protobuf) or [Google Protobuf crate](http://crates.io/crates/google-protobuf).

This is currently a beta release: the API is subject to change,
and there may be some rough edges, including missing documentation and features.

This crate is a shallow wrapper around the `protobuf_codegen` crate that it reexports.

# How to get a compatible version of protoc

The protoc binary that you use to generate code needs to have a version that
exactly matches the version of the protobuf crate you are using. More
specifically, if you are using Rust protobuf `x.y.z` then you need to use protoc
`y.z`. See [here](https://protobuf.dev/support/version-support/) for more
details on our versioning scheme.

The easiest way to get ahold of protoc is to download a prebuilt binary from the
matching release [here](https://github.com/protocolbuffers/protobuf/releases).
Just make sure protoc is on your `$PATH` when you run `cargo`.
Loading