From 0f5e0d34ed70df8de6e5483e86d44ea037ef473c Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Fri, 20 Oct 2017 01:06:57 -0700
Subject: Start of man-page documentation.

This includes a brief summary page and the nng_zerotier man page.
We write all documentation in ASCIIDOC, and our hope is that this
initial effort will inspire others to create amazing documentation
for nng.
---
 doc/README.adoc | 8 ++++++++
 1 file changed, 8 insertions(+)
 create mode 100644 doc/README.adoc

(limited to 'doc/README.adoc')

diff --git a/doc/README.adoc b/doc/README.adoc
new file mode 100644
index 00000000..5030ec42
--- /dev/null
+++ b/doc/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.
-- 
cgit v1.2.3-70-g09d2

