From 87795b46f2bc732bd11067805709161bdc00d6b6 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 25 Feb 2018 17:56:55 -0800 Subject: More man page reorganization. Man pages need special handling, and we can have other kinds of documentation like initial starting guides, etc., which would have different processing applied. So lets move them off into their own directory. --- docs/README.txt | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/README.txt (limited to 'docs/README.txt') diff --git a/docs/README.txt b/docs/README.txt new file mode 100644 index 00000000..5331f67b --- /dev/null +++ b/docs/README.txt @@ -0,0 +1,11 @@ +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. + +The man pages are in the "man" directory. The reason those are separate +is that they get special treatment. Other documentation is located here. -- cgit v1.2.3-70-g09d2