summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4abe2b0..50565c0 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,20 @@
# protobuf definition files for the GO gui plugins
+
+Almost all of this code is autogenerated and there
+are no docs yet. This is an abstraction GUI protobuf
+that allows any protobuf .proto file to be turned
+into a spreadsheet and passed to the GO plugin to
+be displayed to the user.
+
+The only functions written by hand are the Custom()
+functions which pass mouse clicks on the spreadsheet
+cells back to the application.
+
+Rather than try to read this code,
+it's better to look at an example
+application that uses it. (forge, virtigo)
+
+This code is what is called 'winning'
+
+-- jcarr 2025/03/23
+