Mirrors
/
protobuf
mirror of https://github.com/protocolbuffers/protobuf.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
protobuf/README.md

105 lines
4.9 KiB
Markdown
Raw Permalink Normal View History

Initial checkin.
2008-07-09 19:12:20 -07:00
Protocol Buffers - Google's data interchange format
Update README.md to markdown format.
2014-08-28 14:39:49 -07:00
===================================================
Enable OpenSSF Scorecard Action Hi, I'd like to suggest the adoption of the OpenSSF Scorecard Action. The scorecard action runs the OpenSSF Scorecard checks on the repository often to provide feedbacks on how to improve (on the security dashboard) and transparency for the users about the current security posture (shown in the badge). It is also a good way to keep track of new security practices and to provide users easy information about it. See more about scorecard at [OpenSSF Scorecard](https://github.com/ossf/scorecard) and the [Show off your security score](https://openssf.org/blog/2022/09/08/show-off-your-security-score-announcing-scorecards-badges/) PiperOrigin-RevId: 568644059
2023-09-26 14:07:53 -07:00
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/protocolbuffers/protobuf/badge)](https://securityscorecards.dev/viewer/?uri=github.com/protocolbuffers/protobuf)
Update Protobuf readme copyright header PiperOrigin-RevId: 565473469
2023-09-14 14:11:01 -07:00
Copyright 2023 Google LLC
Update README.md to markdown format.
2014-08-28 14:39:49 -07:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
Overview
--------
Initial checkin.
2008-07-09 19:12:20 -07:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
Protocol Buffers (a.k.a., protobuf) are Google's language-neutral,
platform-neutral, extensible mechanism for serializing structured data. You
Updates links to use the new protobuf.dev site, and adds a link to the new version support page. PiperOrigin-RevId: 508485038
2023-02-09 15:00:37 -08:00
can learn more about it in [protobuf's documentation](https://protobuf.dev).
Update README.md and remove INSTALL.txt Added instructions on what tools to install to compile protobuf from source. Removed the INSTALL.txt file because it's just a simple copy of the autoconf documentation and confuses users. Change-Id: I6fd8aa13495f1238fe5c62451b95ad480b1c4bed
2016-01-06 16:25:35 -08:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
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.
Update README.md and remove INSTALL.txt Added instructions on what tools to install to compile protobuf from source. Removed the INSTALL.txt file because it's just a simple copy of the autoconf documentation and confuses users. Change-Id: I6fd8aa13495f1238fe5c62451b95ad480b1c4bed
2016-01-06 16:25:35 -08:00
Put an explicit warning about the incovenience of working against main and a recommendation to use a supported release in the root readme. PiperOrigin-RevId: 613234330
2024-03-06 08:59:05 -08:00
Working With Protobuf Source Code
---------------------------------
Most users will find working from
[supported releases](https://github.com/protocolbuffers/protobuf/releases) to be
the easiest path.
If you choose to work from the head revision of the main branch your build will
occasionally be broken by source-incompatible changes and insufficiently-tested
(and therefore broken) behavior.
If you are using C++ or otherwise need to build protobuf from source as a part
of your project, you should pin to a release commit on a release branch.
This is because even release branches can experience some instability in between
release commits.
readme tweak: protocol -> protobuf PiperOrigin-RevId: 549059493
2023-07-18 11:20:42 -07:00
Protobuf Compiler Installation
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
------------------------------
Update README.md and remove INSTALL.txt Added instructions on what tools to install to compile protobuf from source. Removed the INSTALL.txt file because it's just a simple copy of the autoconf documentation and confuses users. Change-Id: I6fd8aa13495f1238fe5c62451b95ad480b1c4bed
2016-01-06 16:25:35 -08:00
readme tweak: protocol -> protobuf PiperOrigin-RevId: 549059493
2023-07-18 11:20:42 -07:00
The protobuf compiler is written in C++. If you are using C++, please follow
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
the [C++ Installation Instructions](src/README.md) to install protoc along
with the C++ runtime.
Update README.md and remove INSTALL.txt Added instructions on what tools to install to compile protobuf from source. Removed the INSTALL.txt file because it's just a simple copy of the autoconf documentation and confuses users. Change-Id: I6fd8aa13495f1238fe5c62451b95ad480b1c4bed
2016-01-06 16:25:35 -08:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
For non-C++ users, the simplest way to install the protocol compiler is to
Standardize link formatting in documentation. PiperOrigin-RevId: 490577853
2022-11-23 13:53:12 -08:00
download a pre-built binary from our [GitHub release page](https://github.com/protocolbuffers/protobuf/releases).
Add instructions on how to generate the configure script.
2014-08-28 11:18:51 -07:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
In the downloads section of each release, you can find pre-built binaries in
Standardize link formatting in documentation. PiperOrigin-RevId: 490577853
2022-11-23 13:53:12 -08:00
zip packages: `protoc-$VERSION-$PLATFORM.zip`. It contains the protoc binary
as well as a set of standard `.proto` files distributed along with protobuf.
Add instructions on how to generate the configure script.
2014-08-28 11:18:51 -07:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
If you are looking for an old version that is not available in the release
Standardize link formatting in documentation. PiperOrigin-RevId: 490577853
2022-11-23 13:53:12 -08:00
page, check out the [Maven repository](https://repo1.maven.org/maven2/com/google/protobuf/protoc/).
Add instructions on how to generate the configure script.
2014-08-28 11:18:51 -07:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
These pre-built binaries are only provided for released versions. If you want
Replace master with main in URLs & docs
2022-04-12 10:25:08 -07:00
to use the github main version at HEAD, or you need to modify protobuf code,
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
or you are using C++, it's recommended to build your own protoc binary from
source.
Initial checkin.
2008-07-09 19:12:20 -07:00
Remove all autotools usage (#10132) * Bazelfying conformance tests Adding infrastructure to "Bazelify" languages other than Java and C++ * Delete benchmarks for languages supported by other repositories * Bazelfying benchmark tests * Bazelfying python Use upb's system python rule instead of branching tensorflow * Bazelfying Ruby * Bazelfying C# * Bazelfying Objective-c * Bazelfying Kokoro mac builds * Bazelfying Kokoro linux builds * Deleting all deprecated files from autotools cleanup This boils down to Makefile.am and tests.sh and all of their remaining references * Cleanup after PR reorganizing - Enable 32 bit tests - Move conformance tests back - Use select statements to select alternate runtimes - Add internal prefixes to proto library macros * Updating READMEs to use bazel instead of autotools. * Bazelfying Kokoro release builds * First round of review fixes * Second round of review fixes * Third round of review fixes * Filtering out conformance tests from Bazel on Windows (b/241484899) * Add version metadata that was previously scraped from configure.ac * fixing typo from previous fix * Adding ruby version tests * Bumping pinned upb version, and adding tests to python CI
2022-08-10 22:51:29 -07:00
If you would like to build protoc binary from source, see the [C++ Installation Instructions](src/README.md).
Initial checkin.
2008-07-09 19:12:20 -07:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
Protobuf Runtime Installation
-----------------------------
Initial checkin.
2008-07-09 19:12:20 -07:00
Refactor README.md. Move the original README.md to src since it's talking about C++ exclusively and add a more general README.md to document how to install protoc for all languages.
2016-01-21 17:06:38 -08:00
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:
Initial checkin.
2008-07-09 19:12:20 -07:00
Remove build badges, they were consistently out of date and not very useful. (#8634)
2021-05-20 10:06:36 -07:00
| Language | Source |
|--------------------------------------|-------------------------------------------------------------|
| C++ (include C++ runtime and protoc) | [src](src) |
| Java | [java](java) |
| Python | [python](python) |
| Objective-C | [objectivec](objectivec) |
| C# | [csharp](csharp) |
| Ruby | [ruby](ruby) |
| Go | [protocolbuffers/protobuf-go](https://github.com/protocolbuffers/protobuf-go)|
| PHP | [php](php) |
| Dart | [dart-lang/protobuf](https://github.com/dart-lang/protobuf) |
typo fix: Javascript -> JavaScript in protobuf readme PiperOrigin-RevId: 540459923
2023-06-14 20:51:55 -07:00
| JavaScript | [protocolbuffers/protobuf-javascript](https://github.com/protocolbuffers/protobuf-javascript)|
misc. stuff: - Improved readmes. - Fixed incorrect definition of kint32min. - Fixed absolute output paths on Windows. - Added info to Java POM that will be required when we upload the package to a Maven repo.
2008-07-21 13:28:30 -07:00
Add bazel support for examples. The example utilizes native bazel rules (proto_library, cc_proto_library, java_proto_library, java_lite_proto_library) to show how easy it is to build protobuf with bazel's native support. It also makes use of well known types which was not possible until the latest bazel 0.5.4 release and https://github.com/google/protobuf/pull/3594 .
2017-09-08 15:44:09 -07:00
Quick Start
-----------
Initial checkin.
2008-07-09 19:12:20 -07:00
Standardize link formatting in documentation. PiperOrigin-RevId: 490577853
2022-11-23 13:53:12 -08:00
The best way to learn how to use protobuf is to follow the [tutorials in our
Updates links to use the new protobuf.dev site, and adds a link to the new version support page. PiperOrigin-RevId: 508485038
2023-02-09 15:00:37 -08:00
developer guide](https://protobuf.dev/getting-started).
Add bazel support for examples. The example utilizes native bazel rules (proto_library, cc_proto_library, java_proto_library, java_lite_proto_library) to show how easy it is to build protobuf with bazel's native support. It also makes use of well known types which was not possible until the latest bazel 0.5.4 release and https://github.com/google/protobuf/pull/3594 .
2017-09-08 15:44:09 -07:00
If you want to learn from code examples, take a look at the examples in the
[examples](examples) directory.
Documentation
-------------
Initial checkin.
2008-07-09 19:12:20 -07:00
Updates links to use the new protobuf.dev site, and adds a link to the new version support page. PiperOrigin-RevId: 508485038
2023-02-09 15:00:37 -08:00
The complete documentation is available at the [Protocol Buffers doc site](https://protobuf.dev).
Support Policy
--------------
Read about our [version support policy](https://protobuf.dev/version-support/)
to stay current on support timeframes for the language libraries.
Adding a section about the Google Group to the README.md file
2022-07-17 06:16:59 -07:00
Developer Community
-------------------
To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users,
[join the Google Group](https://groups.google.com/g/protobuf).