diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-06 16:20:21 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-06 16:20:21 -0700 |
| commit | aa6d2305b9f8b0eb0e53930e46c157638bc82fdd (patch) | |
| tree | 6799ef137bd1beba7bd5a68741dfc970600be8bf /docs/README.txt | |
| parent | 4f168e08fe34d375df01354ac54fc5e3a2919cb0 (diff) | |
| download | nng-aa6d2305b9f8b0eb0e53930e46c157638bc82fdd.tar.gz nng-aa6d2305b9f8b0eb0e53930e46c157638bc82fdd.tar.bz2 nng-aa6d2305b9f8b0eb0e53930e46c157638bc82fdd.zip | |
idmap public docs converted to mdbook
Diffstat (limited to 'docs/README.txt')
| -rw-r--r-- | docs/README.txt | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/docs/README.txt b/docs/README.txt index 5331f67b..8dae4711 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -1,11 +1,10 @@ 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. +Historically, the documentation was written in asciidoc in the form of man pages. +It is automatically formatted for display on the website. The man pages are in the "man" directory. The reason those are separate is that they get special treatment. Other documentation is located here. + +HOWEVER, we are converting the documentation to mdbook -- see ref/ as the top-level +of the new tree for that. |