From 53ad6a4478b9c206c734b15994f495a12d36f992 Mon Sep 17 00:00:00 2001 From: Protobuf Team Bot Date: Wed, 6 Mar 2024 08:59:05 -0800 Subject: [PATCH] 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 --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 8e0f555da1..e54108f62e 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,23 @@ 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. +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. + Protobuf Compiler Installation ------------------------------