From 08cd2afd86557f06d6b3f6e006d686fef4c7b2ee Mon Sep 17 00:00:00 2001 From: Jeff Carr Date: Sun, 12 Jan 2025 06:13:42 -0600 Subject: adding help --- README | 28 +++++++++------------------- 1 file changed, 9 insertions(+), 19 deletions(-) (limited to 'README') diff --git a/README b/README index da987ea..e14b614 100644 --- a/README +++ b/README @@ -1,23 +1,13 @@ -This app will autogenerate protobuf Sort() and Marshal() functions +# This app will autogenerate Sort() and Marshal() functions for .proto files -It was designed to work on .proto files designed with a standard -way that utilizes this method: +# It was designed to work on .proto files designed with a .proto standard -apple.proto should have +* This will generate: +* Marshal() functions (to protoWIRE, protoTEXT and protoJSON) +* SortBy() functions +* FindBy() functions +* DeleteBy() functions +* AppendBy() functions -message Apples { - string uuid - string version - repeaded Apple Apples -} +# See the examples/ for a sample fruit.proto file that documents what is needed -message Apple { - -} - -This "scheme" as it were will be familar to others as a common way to pluralize data formats. -In general, this is turning out to be a good way to handle protocol buffers for me so far. - -There are several things that can be put in the protobuf file to trigger what files are made. - -See the examples for how to do this. -- cgit v1.2.3