Add user manual source
Template (.im) changes to support the user manual and
the user manual source (new). Readme files were added
to describe current, and future, directory organisation
of the doc portion of the repo.
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I5d7e7b59a73e9c06dc139f419086f1b2f6b45bc2
Add user manual source
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I2c072128ad5ceede9d0329aa4a00b4d60ca5d0eb
Add CMake changes for the user manual
Just a version update; user manual not automatically generated
during build.
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I33ca9dc275e66f5593e84a452d07f3cea50a8543
diff --git a/doc/src/README b/doc/src/README
new file mode 100644
index 0000000..2455710
--- /dev/null
+++ b/doc/src/README
@@ -0,0 +1,25 @@
+
+Directories within this directory contains collections of documents
+such as the manual pages and main RMR user guide. Three are some
+imbed files at this level which make setup to generate document
+output in different flavours (e.g. postscript and troff) possible.
+
+For the most part, document output is genreated during the build
+process and left at the top level build directory. Manual pages
+are the noted exception as the troff output is placed into the
+development pacage files and will be installed with the RMR library
+(archive) such that the standard UNIX man command will generate
+the needed documentation that develoers expect.
+
+
+Directory overview:
+ library - Documentation on the RMR libraray itself. User manual
+ and internal doc.
+
+ binding - Any documentation needed for the language wrappers
+ or bindings.
+
+ man - Manual page source.
+
+ tools - Some useful things that migth make building and/or
+ maintaining documents easier.