tree: 727add0b9106881b399f6a2ecab03b1d9fe146e8 [path history] [tgz]
  1. benchmarks/
  2. cmake/
  3. conformance/
  4. csharp/
  5. docs/
  6. editors/
  7. examples/
  8. java/
  9. js/
  10. kokoro/
  11. m4/
  12. objectivec/
  13. patches/
  14. php/
  15. protoc-artifacts/
  16. python/
  17. ruby/
  18. src/
  19. third_party/
  20. util/
  21. .gitignore
  22. .gitmodules
  23. .travis.yml
  24. BUILD
  25. BUILD.gn
  26. CHANGES.txt
  27. CONTRIBUTORS.txt
  28. DEPS
  29. LICENSE
  30. Makefile.am
  31. OWNERS
  32. Protobuf.podspec
  33. README.chromium
  34. README.md
  35. WORKSPACE
  36. __init__.py
  37. appveyor.bat
  38. appveyor.yml
  39. autogen.sh
  40. composer.json
  41. configure.ac
  42. gen_extra_chromium_files
  43. generate_changelog.py
  44. generate_descriptor_proto.sh
  45. mirclient.cc
  46. mirclient.map
  47. post_process_dist.sh
  48. proto_library.gni
  49. protobuf-lite.pc.in
  50. protobuf.bzl
  51. protobuf.pc.in
  52. six.BUILD
  53. tests.sh
  54. update_file_lists.sh
third_party/protobuf/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:

LanguageSourceUbuntuMacOSWindows
C++ (include C++ runtime and protoc)srcBuild statusBuild status
Build status
Build status
JavajavaBuild status
Build status
Build status
PythonpythonBuild status
Build status
Build status
Build status
Build status
Objective-CobjectivecBuild status
Build status
Build status
Build status
C#csharpBuild statusBuild status
JavaScriptjsBuild statusBuild status
RubyrubyBuild statusBuild status
Build status
Gogolang/protobuf
PHPphpBuild status
Build status
Build status
Build status
Dartdart-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/