aboutsummaryrefslogtreecommitdiff
path: root/tools/pubrefman/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'tools/pubrefman/README.adoc')
-rw-r--r--tools/pubrefman/README.adoc10
1 files changed, 10 insertions, 0 deletions
diff --git a/tools/pubrefman/README.adoc b/tools/pubrefman/README.adoc
new file mode 100644
index 00000000..a8929df9
--- /dev/null
+++ b/tools/pubrefman/README.adoc
@@ -0,0 +1,10 @@
+= pubrefman
+
+This directory contains a tool to publish (update) the reference manual
+on the NNG documentation site.
+
+Run it with --help for options. You can build it with Go.
+
+It normally uploads to github, and will require a working SSH agent.
+
+If you're not a project maintainer, you probably don't need this tool.