summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..29264c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+// Copyright 2025 WIT.COM Inc Licensed GPL 3.0
+
+common config file handling for protobuf defined config files
+
+By default, the config files are stored as:
+
+~/.config/<argname>/<protoname>.text
+
+assumes config files are simple, intended to be edited by hand
+by the user and can be exported by protobuf FormatTEXT()
+
+intended to be called by functions that are automatically
+generated by 'autogenpb' for protobuf defined config files.
+
+If you aren't using .proto defined config files, this package is not for you