C++ Java Objective-C C# C Python Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
benchmarks Fix benchmark build Apr 17, 2018
cmake Fix problem: cmake build failed in c++11 by clang Apr 4, 2018
conformance Updated Ruby conformance test failure list Mar 23, 2018
csharp Write messages to backing field in generated C# cloning code (#4440) Apr 19, 2018
docs Add performance.md and add instruction for linking tcmalloc Mar 23, 2018
editors Improve fix for #295 May 23, 2017
examples Add script for run and upload the benchmark result to bq Apr 10, 2018
java Cleanup + documentation for Java Lite runtime. Apr 13, 2018
js Merge branch (#4466) Apr 2, 2018
kokoro Fix benchmark build Apr 17, 2018
m4 Merge pull request #1333 from cgull/pkg-config-issue Mar 12, 2018
objectivec Move to Xcode 9.3 which also means a High Sierra image. Apr 21, 2018
php fix json_decode call parameters (#4381) Apr 9, 2018
protoc-artifacts Merge branch (#4466) Apr 2, 2018
python Add __init__.py files to compiler and util subpackages (#4117) Apr 9, 2018
ruby Merge branch (#4466) Apr 2, 2018
src Write messages to backing field in generated C# cloning code (#4440) Apr 19, 2018
third_party Include googletest as a submodule (#3993) Mar 26, 2018
util/python Remove hack for building Python support with Bazel. Feb 25, 2016
.gitignore Add __init__.py files to compiler and util subpackages (#4117) Apr 9, 2018
.gitmodules Include googletest as a submodule (#3993) Mar 26, 2018
.travis.yml Move to Xcode 9.3 which also means a High Sierra image. Apr 21, 2018
BUILD Merge pull request #4431 from xfxyjwf/rmnano Mar 26, 2018
CHANGES.txt Update changelog Dec 20, 2017
CONTRIBUTORS.txt Add nano proto authors and update LICENSE file to include Android.mk. Nov 20, 2014
LICENSE Cleanup LICENSE file. Mar 26, 2018
Makefile.am Remove the iOS Test App. Apr 20, 2018
Protobuf.podspec Merge branch (#4466) Apr 2, 2018
README.md Add kokoro build status badges. Mar 28, 2018
WORKSPACE Include googletest as a submodule (#3993) Mar 26, 2018
appveyor.bat Adjusted appveyor batch Feb 6, 2018
appveyor.yml Include googletest as a submodule (#3993) Mar 26, 2018
autogen.sh Include googletest as a submodule (#3993) Mar 26, 2018
composer.json Update PHP descriptors (#3391) Aug 4, 2017
configure.ac Merge branch (#4466) Apr 2, 2018
generate_changelog.py generate_changelog.py: flush output so piping works correctly. Dec 10, 2016
generate_descriptor_proto.sh Merge from Google internal for 3.4 release Jul 18, 2017
post_process_dist.sh Add protobuf-all in post release Nov 15, 2017
protobuf-lite.pc.in Uncomment conflict fields from pkg-config files. May 12, 2015
protobuf.bzl Output *_pb2_grpc.py when use_grpc_plugin=True Mar 11, 2018
protobuf.pc.in Uncomment conflict fields from pkg-config files. May 12, 2015
six.BUILD Add srcs_version = "PY2AND3" in BUILD files Dec 3, 2015
tests.sh Add script for run and upload the benchmark result to bq Apr 10, 2018
update_file_lists.sh Remove javanano. Mar 26, 2018

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/google/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
Java java Build status
Build status
Build status
Python python 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
JavaScript js Build status Build status
Ruby ruby 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

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/