Go to file
Jon Skeet 2158851bb1 Update C#-specific README
In particular, this removes the now-inaccurate instructions for building
Google.Protobuf targeting .NET 3.5.
2022-07-15 16:18:29 +01:00
.github Sync from Piper @461045587 2022-07-14 21:05:36 +00:00
benchmarks Sync from Piper @461045587 2022-07-14 21:05:36 +00:00
build_defs
cmake Sync from Piper @461060848 2022-07-14 22:13:36 +00:00
conformance Merge pull request #10206 from Zedenem/fix/conformance_cpp_ReadFd_parameter_error 2022-07-12 17:25:43 -04:00
csharp Update C#-specific README 2022-07-15 16:18:29 +01:00
docs Sync from Piper @458241011 2022-06-30 16:14:29 +00:00
editors
examples Correct file extention of README (#10125) 2022-06-09 15:52:50 -07:00
java Sync from Piper @461045587 2022-07-14 21:05:36 +00:00
kokoro Merge pull request #10241 from deannagarcia/csharpBuild 2022-07-12 21:32:08 +00:00
m4
objectivec Add package_as_prefix_forced_prefix generation option. 2022-06-15 09:52:57 -04:00
php ran generate_descriptor_proto.sh 2022-06-30 23:33:15 +00:00
pkg Adding Github Action to keep CMake generated file lists up to date (#10243) 2022-07-11 22:04:40 -07:00
protoc-artifacts revert autotool changes 2022-07-06 21:41:03 +00:00
python Sync from Piper @461045587 2022-07-14 21:05:36 +00:00
ruby Sync from Piper @457757259 2022-06-28 17:01:18 +00:00
src Merge pull request #10254 from haberman/sync-stage 2022-07-14 16:23:44 -07:00
third_party
toolchain
util/python
.bazelignore
.gitignore
.gitmodules
.readthedocs.yml
BUILD.bazel Adding Github Action to keep CMake generated file lists up to date (#10243) 2022-07-11 22:04:40 -07:00
CHANGES.txt Updated CHANGES.txt. 2022-07-14 21:09:25 +00:00
CMakeLists.txt
CONTRIBUTING.md
CONTRIBUTORS.txt
LICENSE
Makefile.am Merge pull request #10244 from jskeet/plugin-protos 2022-07-14 22:47:22 +00:00
Protobuf-C++.podspec merge 21.x into main 2022-06-27 20:45:52 +00:00
Protobuf.podspec Sync from Piper @457757259 2022-06-28 17:01:18 +00:00
README.md
SECURITY.md
WORKSPACE
appveyor.bat
appveyor.yml
autogen.sh
configure.ac merge 21.x into main 2022-06-27 20:45:52 +00:00
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 Sync from Piper @459854290 2022-07-08 23:14:35 +00:00
protobuf_release.bzl
protobuf_version.bzl Sync from Piper @457757259 2022-06-28 17:01:18 +00:00
tests.sh
update_compatibility_version.py
version.json revert version.json 2022-06-27 21:04:34 +00:00

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/