| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 1 | Protocol Buffers - Google's data interchange format |
| Feng Xiao | 17007a6 | 2014-08-28 14:39:49 -0700 | [diff] [blame] | 2 | =================================================== |
| 3 | |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 4 | Copyright 2008 Google Inc. |
| Feng Xiao | 17007a6 | 2014-08-28 14:39:49 -0700 | [diff] [blame] | 5 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 6 | Overview |
| 7 | -------- |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 8 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 9 | Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, |
| 10 | platform-neutral, extensible mechanism for serializing structured data. You |
| Protobuf Team Bot | 23d8aac | 2023-02-09 15:00:37 -0800 | [diff] [blame] | 11 | can learn more about it in [protobuf's documentation](https://protobuf.dev). |
| Feng Xiao | 64d8652 | 2016-01-06 16:25:35 -0800 | [diff] [blame] | 12 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 13 | This README file contains protobuf installation instructions. To install |
| 14 | protobuf, you need to install the protocol compiler (used to compile .proto |
| 15 | files) and the protobuf runtime for your chosen programming language. |
| Feng Xiao | 64d8652 | 2016-01-06 16:25:35 -0800 | [diff] [blame] | 16 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 17 | Protocol Compiler Installation |
| 18 | ------------------------------ |
| Feng Xiao | 64d8652 | 2016-01-06 16:25:35 -0800 | [diff] [blame] | 19 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 20 | The protocol compiler is written in C++. If you are using C++, please follow |
| 21 | the [C++ Installation Instructions](src/README.md) to install protoc along |
| 22 | with the C++ runtime. |
| Feng Xiao | 64d8652 | 2016-01-06 16:25:35 -0800 | [diff] [blame] | 23 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 24 | For non-C++ users, the simplest way to install the protocol compiler is to |
| Protobuf Team Bot | 016ef23 | 2022-11-23 13:53:12 -0800 | [diff] [blame] | 25 | download a pre-built binary from our [GitHub release page](https://github.com/protocolbuffers/protobuf/releases). |
| Feng Xiao | de00052 | 2014-08-28 11:18:51 -0700 | [diff] [blame] | 26 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 27 | In the downloads section of each release, you can find pre-built binaries in |
| Protobuf Team Bot | 016ef23 | 2022-11-23 13:53:12 -0800 | [diff] [blame] | 28 | zip packages: `protoc-$VERSION-$PLATFORM.zip`. It contains the protoc binary |
| 29 | as well as a set of standard `.proto` files distributed along with protobuf. |
| Feng Xiao | de00052 | 2014-08-28 11:18:51 -0700 | [diff] [blame] | 30 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 31 | If you are looking for an old version that is not available in the release |
| Protobuf Team Bot | 016ef23 | 2022-11-23 13:53:12 -0800 | [diff] [blame] | 32 | page, check out the [Maven repository](https://repo1.maven.org/maven2/com/google/protobuf/protoc/). |
| Feng Xiao | de00052 | 2014-08-28 11:18:51 -0700 | [diff] [blame] | 33 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 34 | These pre-built binaries are only provided for released versions. If you want |
| noahdietz | 5abf802 | 2022-04-12 10:25:08 -0700 | [diff] [blame] | 35 | to use the github main version at HEAD, or you need to modify protobuf code, |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 36 | or you are using C++, it's recommended to build your own protoc binary from |
| 37 | source. |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 38 | |
| Mike Kruskal | ed5c57a | 2022-08-10 22:51:29 -0700 | [diff] [blame] | 39 | If you would like to build protoc binary from source, see the [C++ Installation Instructions](src/README.md). |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 40 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 41 | Protobuf Runtime Installation |
| 42 | ----------------------------- |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 43 | |
| Feng Xiao | d0e0114 | 2016-01-21 17:06:38 -0800 | [diff] [blame] | 44 | Protobuf supports several different programming languages. For each programming |
| 45 | language, you can find instructions in the corresponding source directory about |
| 46 | how to install protobuf runtime for that specific language: |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 47 | |
| Joshua Haberman | 96ccf40 | 2021-05-20 10:06:36 -0700 | [diff] [blame] | 48 | | Language | Source | |
| 49 | |--------------------------------------|-------------------------------------------------------------| |
| 50 | | C++ (include C++ runtime and protoc) | [src](src) | |
| 51 | | Java | [java](java) | |
| 52 | | Python | [python](python) | |
| 53 | | Objective-C | [objectivec](objectivec) | |
| 54 | | C# | [csharp](csharp) | |
| Joshua Haberman | 96ccf40 | 2021-05-20 10:06:36 -0700 | [diff] [blame] | 55 | | Ruby | [ruby](ruby) | |
| 56 | | Go | [protocolbuffers/protobuf-go](https://github.com/protocolbuffers/protobuf-go)| |
| 57 | | PHP | [php](php) | |
| 58 | | Dart | [dart-lang/protobuf](https://github.com/dart-lang/protobuf) | |
| Noel Kim (김민혁) | e58ff98 | 2022-08-31 01:30:54 +0900 | [diff] [blame] | 59 | | Javascript | [protocolbuffers/protobuf-javascript](https://github.com/protocolbuffers/protobuf-javascript)| |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 60 | |
| Feng Xiao | 74bf45f | 2017-09-08 15:44:09 -0700 | [diff] [blame] | 61 | Quick Start |
| 62 | ----------- |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 63 | |
| Protobuf Team Bot | 016ef23 | 2022-11-23 13:53:12 -0800 | [diff] [blame] | 64 | The best way to learn how to use protobuf is to follow the [tutorials in our |
| Protobuf Team Bot | 23d8aac | 2023-02-09 15:00:37 -0800 | [diff] [blame] | 65 | developer guide](https://protobuf.dev/getting-started). |
| Feng Xiao | 74bf45f | 2017-09-08 15:44:09 -0700 | [diff] [blame] | 66 | |
| 67 | If you want to learn from code examples, take a look at the examples in the |
| 68 | [examples](examples) directory. |
| 69 | |
| 70 | Documentation |
| 71 | ------------- |
| temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 72 | |
| Protobuf Team Bot | 23d8aac | 2023-02-09 15:00:37 -0800 | [diff] [blame] | 73 | The complete documentation is available at the [Protocol Buffers doc site](https://protobuf.dev). |
| 74 | |
| 75 | Support Policy |
| 76 | -------------- |
| 77 | |
| 78 | Read about our [version support policy](https://protobuf.dev/version-support/) |
| 79 | to stay current on support timeframes for the language libraries. |
| Protocol Buffers Docs | 1cb0d64 | 2022-07-17 13:16:59 +0000 | [diff] [blame] | 80 | |
| 81 | Developer Community |
| 82 | ------------------- |
| 83 | |
| 84 | To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users, |
| 85 | [join the Google Group](https://groups.google.com/g/protobuf). |
