aboutsummaryrefslogtreecommitdiff
path: root/tools/pubrefman/README.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2020-08-02 11:58:44 -0700
committerGarrett D'Amore <garrett@damore.org>2020-08-02 11:58:44 -0700
commit0b7ee395e832165b2e7726231cc12bb06b3bbe5b (patch)
tree17bde337059ed70a1ee5734f6af3c85eee6ac8a5 /tools/pubrefman/README.adoc
parent07846a10b7a840b206a1c24f1df70e2fbaed1fd4 (diff)
downloadnng-0b7ee395e832165b2e7726231cc12bb06b3bbe5b.tar.gz
nng-0b7ee395e832165b2e7726231cc12bb06b3bbe5b.tar.bz2
nng-0b7ee395e832165b2e7726231cc12bb06b3bbe5b.zip
fixes #1270 Move web page publication tool to main branch
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.