aboutsummaryrefslogtreecommitdiff
path: root/etc/pubrefman/README.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2021-01-01 11:30:03 -0800
committerGarrett D'Amore <garrett@damore.org>2021-01-01 12:46:17 -0800
commited542ac45e00c9b2faa0b41f3c00de6e291e5678 (patch)
tree673924ff077d468e6756529c2c204698d3faa47c /etc/pubrefman/README.adoc
parent1413b2421a82cd9b9cde178d44fb60c7893176b0 (diff)
downloadnng-ed542ac45e00c9b2faa0b41f3c00de6e291e5678.tar.gz
nng-ed542ac45e00c9b2faa0b41f3c00de6e291e5678.tar.bz2
nng-ed542ac45e00c9b2faa0b41f3c00de6e291e5678.zip
fixes #1345 Restructure the source tree
This is not quite complete, but it sets the stage for other protocols (such as zmq or mqtt) to be added to the project.
Diffstat (limited to 'etc/pubrefman/README.adoc')
-rw-r--r--etc/pubrefman/README.adoc10
1 files changed, 10 insertions, 0 deletions
diff --git a/etc/pubrefman/README.adoc b/etc/pubrefman/README.adoc
new file mode 100644
index 00000000..a8929df9
--- /dev/null
+++ b/etc/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.