diff options
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. |