Add and expand more readme files for module documentation

1 files changed, 30 insertions, 8 deletions

diff --git a/rsc/README b/rsc/README
index 09e2cd594c73..ed940f727fb0 100644
--- a/rsc/README
+++ b/rsc/README
@@ -1,10 +1,32 @@
 Resource Compiler.
 
-There is some German documentation about it in a subdirectory called [git:rsc/doku].
-Seems to be very old (January 1992).
-
-From rsc.sdw (in German):
-The StarView Resource Compiler (rsc) is used, to convert the system-independent
-resources in the description files to native description files which in turn are
-compiled efficiently (runtime) by the system's native resource compiler in binary
-resources.
+This compiler converts .src files and .hrc equivalents into binary
+.res files.  The basic idea is that this provides a map between
+integer identifiers and the resources: string, pixmap (only the
+file-name), and VCL control properties.
+
+In more detail:
+
+Typically we would have a .hrc file with entries like this:
+
+#define SID_STR_FOO    1234
+
+And then a .src file with some entries like this:
+
+String SID_STR_FOO
+{
+    Text [ en-US ] = "Foo !" ;
+};
+
+This is compiled into a binary resource file, we have many of these
+which live in program/resource/ and then tends to get used in the code
+thus:
+
+String aStr( ResId( SID_STR_FOO ) );
+
+It is important to note that any appearance of hierarchical structure
+in the .src files is in fact a mirage. The file is compiled at root
+into a plain map<integer,resource>.
+
+There is some German documentation about it in a subdirectory called
+[git:rsc/doku].  Seems to be very old (January 1992).