aboutsummaryrefslogtreecommitdiff
path: root/docs/README.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2017-10-24 11:46:24 -0700
committerGarrett D'Amore <garrett@damore.org>2017-10-24 11:46:24 -0700
commita7b20c3babd965b12dec8cb5ff0883a4d8d1116d (patch)
tree35d3c001ebe57d5320fcd75963fad5f5a2c6faec /docs/README.adoc
parent5c45bc28facc08601431df95a751e9f6a9d80c3a (diff)
downloadnng-a7b20c3babd965b12dec8cb5ff0883a4d8d1116d.tar.gz
nng-a7b20c3babd965b12dec8cb5ff0883a4d8d1116d.tar.bz2
nng-a7b20c3babd965b12dec8cb5ff0883a4d8d1116d.zip
Doc directory moved to make github pages happy.
Diffstat (limited to 'docs/README.adoc')
-rw-r--r--docs/README.adoc8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/README.adoc b/docs/README.adoc
new file mode 100644
index 00000000..5030ec42
--- /dev/null
+++ b/docs/README.adoc
@@ -0,0 +1,8 @@
+This contains the nng documentation for API users.
+
+The documentation is written in asciidoc in the form of man pages. It is
+automatically formatted for display on the website.
+
+It is possible to emit TROFF sources for use by the UNIX man page, and HTML
+for online viewing. asciidoctor supports PDF and EPUB formats via plugins,
+so there are still more options available.