diff options
| author | Garrett D'Amore <garrett@damore.org> | 2017-10-20 01:06:57 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2017-10-20 10:24:22 -0700 |
| commit | 0f5e0d34ed70df8de6e5483e86d44ea037ef473c (patch) | |
| tree | b7f3090390d74f1554483e2ba9e4619e207dacb9 /doc/README.adoc | |
| parent | f9e654e04ce30bb2721073fda9962b4491bffdde (diff) | |
| download | nng-0f5e0d34ed70df8de6e5483e86d44ea037ef473c.tar.gz nng-0f5e0d34ed70df8de6e5483e86d44ea037ef473c.tar.bz2 nng-0f5e0d34ed70df8de6e5483e86d44ea037ef473c.zip | |
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.
Diffstat (limited to 'doc/README.adoc')
| -rw-r--r-- | doc/README.adoc | 8 |
1 files changed, 8 insertions, 0 deletions
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. |