jason 075d766964 first 3 years ago
..
.github 075d766964 first 3 years ago
benchmarks 075d766964 first 3 years ago
cmake 075d766964 first 3 years ago
conformance 075d766964 first 3 years ago
csharp 075d766964 first 3 years ago
docs 075d766964 first 3 years ago
editors 075d766964 first 3 years ago
examples 075d766964 first 3 years ago
java 075d766964 first 3 years ago
js 075d766964 first 3 years ago
kokoro 075d766964 first 3 years ago
m4 075d766964 first 3 years ago
objectivec 075d766964 first 3 years ago
php 075d766964 first 3 years ago
protoc-artifacts 075d766964 first 3 years ago
python 075d766964 first 3 years ago
ruby 075d766964 first 3 years ago
src 075d766964 first 3 years ago
third_party 075d766964 first 3 years ago
util 075d766964 first 3 years ago
.gitignore 075d766964 first 3 years ago
.gitmodules 075d766964 first 3 years ago
BUILD 075d766964 first 3 years ago
CHANGES.txt 075d766964 first 3 years ago
CONTRIBUTING.md 075d766964 first 3 years ago
CONTRIBUTORS.txt 075d766964 first 3 years ago
LICENSE 075d766964 first 3 years ago
Makefile.am 075d766964 first 3 years ago
Protobuf-C++.podspec 075d766964 first 3 years ago
Protobuf.podspec 075d766964 first 3 years ago
README.md 075d766964 first 3 years ago
WORKSPACE 075d766964 first 3 years ago
appveyor.bat 075d766964 first 3 years ago
appveyor.yml 075d766964 first 3 years ago
autogen.sh 075d766964 first 3 years ago
build_files_updated_unittest.sh 075d766964 first 3 years ago
cc_proto_blacklist_test.bzl 075d766964 first 3 years ago
compiler_config_setting.bzl 075d766964 first 3 years ago
composer.json 075d766964 first 3 years ago
configure.ac 075d766964 first 3 years ago
generate_changelog.py 075d766964 first 3 years ago
generate_descriptor_proto.sh 075d766964 first 3 years ago
global.json 075d766964 first 3 years ago
post_process_dist.sh 075d766964 first 3 years ago
protobuf-lite.pc.in 075d766964 first 3 years ago
protobuf.bzl 075d766964 first 3 years ago
protobuf.pc.in 075d766964 first 3 years ago
protobuf_deps.bzl 075d766964 first 3 years ago
tests.sh 075d766964 first 3 years ago
update_compatibility_version.py 075d766964 first 3 years ago
update_file_lists.sh 075d766964 first 3 years ago
update_version.py 075d766964 first 3 years ago

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
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/