X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2FREADME;fp=doc%2Fsrc%2FREADME;h=2455710284514bbef6c94bc88319a353e79a7945;hb=06e85b7015b6804e641424a022d0a9ceb282e280;hp=0000000000000000000000000000000000000000;hpb=f68c2ced7de2bdfc475a9282cde91a67d83325de;p=ric-plt%2Flib%2Frmr.git

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.