summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Meeks <michael.meeks@suse.com>2012-02-08 11:17:22 +0000
committerMichael Meeks <michael.meeks@suse.com>2012-02-08 11:18:15 +0000
commit1f63bd653cad40ec1d6aa111cc66959a93d120ce (patch)
tree3904dd69d0c84588194d0accdfd89c5a0c9d512d
parent849a2471bd649b252648fa4e43be91dab4d9bdc5 (diff)
Add and expand more readme files for module documentation
-rw-r--r--bin/README9
-rw-r--r--distro-configs/README14
-rw-r--r--icon-themes/README (renamed from icon-themes/README.txt)21
-rw-r--r--rsc/README38
-rw-r--r--scaddins/README4
5 files changed, 78 insertions, 8 deletions
diff --git a/bin/README b/bin/README
new file mode 100644
index 000000000000..72dbdcd4bcac
--- /dev/null
+++ b/bin/README
@@ -0,0 +1,9 @@
+Tools and scripts used during the build
+
+This direction has a number of key pieces that are used during the
+build, or are simply generally useful. One example is
+
+bin/find-german-comments <directory>
+
+which will try to detect and extract all the German comments in a
+given source code hireachy / directory. \ No newline at end of file
diff --git a/distro-configs/README b/distro-configs/README
new file mode 100644
index 000000000000..f22328fe804a
--- /dev/null
+++ b/distro-configs/README
@@ -0,0 +1,14 @@
+Pre-canned distribution / platform configurations
+
+When the software is configured for a platform, since we run on so
+many platforms, detecting the best sequence of configure options to
+get it building is hard.
+
+Instead we have a text file containing the recommended (often the
+distributed) version of these parameters, one per distribution or
+significant platform. These are interpreted by autogen.sh and
+eventually end up passed to configure. Thus:
+
+./autogen.sh --with-distro=LibreOfficeAndroid
+
+might build a version tweaked for Android.
diff --git a/icon-themes/README.txt b/icon-themes/README
index e6514d863fc8..765571037fa8 100644
--- a/icon-themes/README.txt
+++ b/icon-themes/README
@@ -1,3 +1,24 @@
+Icon repository for the applications
+
+All of the icons, separated by themes are included in this
+directory. These icons are built into .zip files, and re-ordered /
+packed for efficiency reasons based on our UI configuration by the
+packimages/ module.
+
+An icon theme does not need to contain all images, since these can be
+layered one on top of another.
+
+In general the layering is done like this:
+
+<leaf theme>
+tango
+industrial
+galaxy
+
+The classic theme is left primarily for historical interest, rather
+than intended to be packaged.
+
+
How to add a new image set:
---------------------------
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).
diff --git a/scaddins/README b/scaddins/README
index b27348c61f4b..3ad6de64e5c1 100644
--- a/scaddins/README
+++ b/scaddins/README
@@ -1,4 +1,8 @@
Extra functions for calc.
+These provide UNO components that implement more exotic calc
+functions. If you want to do the same, here can be a good place to
+start.
+
See also:
[http://wiki.services.openoffice.org/wiki/Scaddins]