3edec1f288
* Initial implementation of cmake tests for linux * Reverting accidental distcheck changes * Deleting extract_includes.bat now that it's been replaced with the generated file_lists.cmake * Removing unnecessary endif conditions |
||
|---|---|---|
| .github | ||
| benchmarks | ||
| build_defs | ||
| cmake | ||
| conformance | ||
| csharp | ||
| docs | ||
| editors | ||
| examples | ||
| java | ||
| kokoro | ||
| m4 | ||
| objectivec | ||
| php | ||
| pkg | ||
| protoc-artifacts | ||
| python | ||
| ruby | ||
| src | ||
| third_party | ||
| toolchain | ||
| util/python | ||
| .bazelignore | ||
| .gitignore | ||
| .gitmodules | ||
| .readthedocs.yml | ||
| BUILD.bazel | ||
| CHANGES.txt | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS.txt | ||
| LICENSE | ||
| Makefile.am | ||
| Protobuf-C++.podspec | ||
| Protobuf.podspec | ||
| README.md | ||
| SECURITY.md | ||
| WORKSPACE | ||
| appveyor.bat | ||
| appveyor.yml | ||
| autogen.sh | ||
| configure.ac | ||
| fix_permissions.sh | ||
| generate_changelog.py | ||
| generate_descriptor_proto.sh | ||
| global.json | ||
| maven_install.json | ||
| post_process_dist.sh | ||
| protobuf-lite.pc.in | ||
| protobuf.bzl | ||
| protobuf.pc.in | ||
| protobuf_deps.bzl | ||
| protobuf_release.bzl | ||
| protobuf_version.bzl | ||
| tests.sh | ||
| update_compatibility_version.py | ||
| version.json | ||
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 main 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 |
|---|---|
| C++ (include C++ runtime and protoc) | src |
| Java | java |
| Python | python |
| Objective-C | objectivec |
| C# | csharp |
| Ruby | ruby |
| Go | protocolbuffers/protobuf-go |
| PHP | php |
| 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/
Developer Community
To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users, join the Google Group.