From 52089cf062d916f005e82e98f6f4a48d1920cfb5 Mon Sep 17 00:00:00 2001 From: Jeff Carr Date: Sun, 31 Aug 2025 08:59:33 -0500 Subject: [PATCH] notes --- README | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README b/README index e14b614..b024767 100644 --- a/README +++ b/README @@ -1,4 +1,14 @@ -# This app will autogenerate Sort() and Marshal() functions for .proto files +# This app auto-generates *.pb.go files +# +# It assumes you are doing GO development in ~/go/src +# Although it might work with go.work directory setups +# I haven't tested that much yet because I haven't had time + +# This app DOES NOT LIKE THINGS WHEN THE PATHS ARE NOT ABSOLUTE GO namespace paths +# that is, if you make a go.work file and tell it gitea.mystuff.org/foo is actually in foo/ +# none of the autogen things will probably work. Notsure. Anyway, it's not interesting +# to me to try that since this is hard enough already I don't have time to debug that +# but will of course accept patches # It was designed to work on .proto files designed with a .proto standard @@ -11,3 +21,5 @@ # See the examples/ for a sample fruit.proto file that documents what is needed +# You will notice if you have checked out this project the *pb.go files are ignored in the .gitignore +# file. See the app 'forge' on how publishing and versioning works with this codebase.