You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

88 lines
4.6 KiB

6 years ago
  1. Protocol Buffers - Google's data interchange format
  2. ===================================================
  3. [![Build Status](https://travis-ci.org/google/protobuf.svg?branch=master)](https://travis-ci.org/google/protobuf) [![Build status](https://ci.appveyor.com/api/projects/status/73ctee6ua4w2ruin?svg=true)](https://ci.appveyor.com/project/protobuf/protobuf) [![Build Status](https://grpc-testing.appspot.com/buildStatus/icon?job=protobuf_branch)](https://grpc-testing.appspot.com/job/protobuf_branch) [![Build Status](https://grpc-testing.appspot.com/job/protobuf_branch_32/badge/icon)](https://grpc-testing.appspot.com/job/protobuf_branch_32) [![Build Status](http://ci.bazel.io/buildStatus/icon?job=protobuf)](http://ci.bazel.io/job/protobuf/)
  4. Copyright 2008 Google Inc.
  5. https://developers.google.com/protocol-buffers/
  6. Overview
  7. --------
  8. Protocol Buffers (a.k.a., protobuf) are Google's language-neutral,
  9. platform-neutral, extensible mechanism for serializing structured data. You
  10. can find [protobuf's documentation on the Google Developers site](https://developers.google.com/protocol-buffers/).
  11. This README file contains protobuf installation instructions. To install
  12. protobuf, you need to install the protocol compiler (used to compile .proto
  13. files) and the protobuf runtime for your chosen programming language.
  14. Protocol Compiler Installation
  15. ------------------------------
  16. The protocol compiler is written in C++. If you are using C++, please follow
  17. the [C++ Installation Instructions](src/README.md) to install protoc along
  18. with the C++ runtime.
  19. For non-C++ users, the simplest way to install the protocol compiler is to
  20. download a pre-built binary from our release page:
  21. [https://github.com/google/protobuf/releases](https://github.com/google/protobuf/releases)
  22. In the downloads section of each release, you can find pre-built binaries in
  23. zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary
  24. as well as a set of standard .proto files distributed along with protobuf.
  25. If you are looking for an old version that is not available in the release
  26. page, check out the maven repo here:
  27. [https://repo1.maven.org/maven2/com/google/protobuf/protoc/](https://repo1.maven.org/maven2/com/google/protobuf/protoc/)
  28. These pre-built binaries are only provided for released versions. If you want
  29. to use the github master version at HEAD, or you need to modify protobuf code,
  30. or you are using C++, it's recommended to build your own protoc binary from
  31. source.
  32. If you would like to build protoc binary from source, see the [C++ Installation
  33. Instructions](src/README.md).
  34. Protobuf Runtime Installation
  35. -----------------------------
  36. Protobuf supports several different programming languages. For each programming
  37. language, you can find instructions in the corresponding source directory about
  38. how to install protobuf runtime for that specific language:
  39. | Language | Source |
  40. |--------------------------------------|-------------------------------------------------------------|
  41. | C++ (include C++ runtime and protoc) | [src](src) |
  42. | Java | [java](java) |
  43. | Python | [python](python) |
  44. | Objective-C | [objectivec](objectivec) |
  45. | C# | [csharp](csharp) |
  46. | JavaNano | [javanano](javanano) |
  47. | JavaScript | [js](js) |
  48. | Ruby | [ruby](ruby) |
  49. | Go | [golang/protobuf](https://github.com/golang/protobuf) |
  50. | PHP | [php](php) |
  51. | Dart | [dart-lang/protobuf](https://github.com/dart-lang/protobuf) |
  52. Quick Start
  53. -----------
  54. The best way to learn how to use protobuf is to follow the tutorials in our
  55. developer guide:
  56. https://developers.google.com/protocol-buffers/docs/tutorials
  57. If you want to learn from code examples, take a look at the examples in the
  58. [examples](examples) directory.
  59. Documentation
  60. -------------
  61. The complete documentation for Protocol Buffers is available via the
  62. web at:
  63. https://developers.google.com/protocol-buffers/