Skip to content

P
protobuf
Switch branch/tag
History Find file
Name
Last commit
 Last update
.github/ISSUE_TEMPLATE Add github issue templates
benchmarks First pass at benchmarking for C#
cmake Fix CMake conflict
conformance Update conformance test failures
csharp add System.Memory dependency (#5835)
docs Added Optional GRPC library to third party docs
editors Improve fix for https://github.com/google/protobuf/issues/295
examples create importable function for defining zlib
java Merge branch 'contributing' of https://github.com/haon4/protobuf into contributing
js Down integrate to Github
kokoro add missing C# windows presubmit.cfg file (#5894)
m4 Mostly fix Sun Studio configuration using SunCC compiler
objectivec Stop enabling more warnings for CXX compiles.
php Add terminating character to zend_lookup_class call (#5871)
protoc-artifacts Update version number to 3.7.0 (#5793)
python Undelete python/google/protobuf/pyext/proto2_api_test.proto that was accidentally removed from file_list
ruby Fix ruby continuous tests (#5853)
src Merge branch 'contributing' of https://github.com/haon4/protobuf into contributing
third_party Revert "Add stack overflow protection for text format"
util/python Remove hack for building Python support with Bazel.
.gitignore Php 7.3 fix (#5434)
.gitmodules Include googletest as a submodule (#3993)
BUILD Bazel: Add dependency to error_prone_annotations
CHANGES.txt Update CHANGES.txt
CONTRIBUTING.md Update CONTRIBUTING.md to recommend applying the appropriate labels
CONTRIBUTORS.txt Add nano proto authors and update LICENSE file to include Android.mk.
LICENSE Cleanup LICENSE file.
Makefile.am Add C# benchmark files to EXTRA_DIST in Makefile.am
Protobuf.podspec Update version number to 3.7.0 (#5793)
README.md Add link to continuous test badges (#5855)
WORKSPACE Bazel: Add dependency to error_prone_annotations
appveyor.bat use netcoreapp2.1 for testing
appveyor.yml Merge branch '3.6.x' into merge-3-6-x
autogen.sh Add cpp tests under release docker image.
compiler_config_setting.bzl Create compiler_config_setting.bzl
composer.json Update PHP descriptors (#3391)
configure.ac Update version number to 3.7.0 (#5793)
generate_changelog.py Replace repo links.
generate_descriptor_proto.sh Down-integrate from google3.
global.json Bump target frameworks of C# programs from netcoreapp1.0 to netcoreapp2.1 (#5838)
post_process_dist.sh Removed javanano from post_process_dist.sh
protobuf-lite.pc.in `Libs` should not include `@PTHREAD_CFLAGS@`
protobuf.bzl Down-integrate internal changes (#5467)
protobuf.pc.in `Libs` should not include `@PTHREAD_CFLAGS@`
protobuf_deps.bzl create importable function for defining zlib
six.BUILD Add srcs_version = "PY2AND3" in BUILD files
tests.sh Merge pull request #5876 from jtattermusch/csharp_win_tests
update_file_lists.sh fix duplicate mkdir in update_file_lists.sh
update_version.py Merge branch '3.7.x'
README.md

Protocol Buffers - Google's data interchange format

Copyright 2008 Google Inc.

https://developers.google.com/protocol-buffers/

Overview

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can find protobuf's documentation on the Google Developers site.

This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.

Protocol Compiler Installation

The protocol compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.

For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our release page:

https://github.com/protocolbuffers/protobuf/releases

In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.

If you are looking for an old version that is not available in the release page, check out the maven repo here:

https://repo1.maven.org/maven2/com/google/protobuf/protoc/

These pre-built binaries are only provided for released versions. If you want to use the github master version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.

If you would like to build protoc binary from source, see the C++ Installation Instructions.

Protobuf Runtime Installation

Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:

Language Source Ubuntu MacOS Windows
C++ (include C++ runtime and protoc) src Build status
Build status
Build status 		Build status
Build status 		Build status
Java java Build status
Build status
Build status
Python python Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status
Build status 		Build status
Build status
Build status 		Build status
Objective-C objectivec Build status
Build status
Build status
Build status
C# csharp Build status Build status
Build status
JavaScript js Build status Build status
Ruby ruby Build status
Build status
Build status
Build status
Build status 		Build status
Build status
Build status
Build status
Build status
Go golang/protobuf
PHP php Build status
Build status 		Build status
Build status
Dart dart-lang/protobuf Build Status

Quick Start

The best way to learn how to use protobuf is to follow the tutorials in our developer guide:

https://developers.google.com/protocol-buffers/docs/tutorials

If you want to learn from code examples, take a look at the examples in the examples directory.

Documentation

The complete documentation for Protocol Buffers is available via the web at:

https://developers.google.com/protocol-buffers/