Added (and improved) READMEs for modules which used to be in libs-gui

19 files changed, 75 insertions, 5 deletions

diff --git a/basebmp/README b/basebmp/README
new file mode 100644
index 000000000000..f6dc91477cca
--- /dev/null
+++ b/basebmp/README
@@ -0,0 +1,7 @@
+Provides a BitmapDevice: the vcl software renderer
+
+Provides algorithms and data types for bitmap graphics
+e.g. line and fill polygon scan conversion, bitmap format iterators, and a SalGraphics-compatible software renderer
+
+Used for example for wmf / svm files.
+E.g. used when you do -headless, and have no DISPLAY set - it's an all-software backend for the LibO graphic backend. also see [git:vcl/headless].
diff --git a/basegfx/README b/basegfx/README
new file mode 100644
index 000000000000..99f0feb7ae30
--- /dev/null
+++ b/basegfx/README
@@ -0,0 +1 @@
+Algorithms and data types for graphics (e.g. polygons, vectors, matrices and the like - see that used in [[canvas]]).
diff --git a/canvas/overview.txt b/canvas/README
index 5d508b04bc45..ee9dc5880171 100644
--- a/canvas/overview.txt
+++ b/canvas/README
@@ -1,5 +1,6 @@
-The new OOo Canvas Framework
-============================
+New canvas implementation to improve rendering, various backends implement the new XCanvas API eg. Cairo / DirectX.
+
+== The new OOo Canvas Framework ==
 
 The new OpenOffice.org canvas framework is the successor of the system
 GUI and graphics backend VCL. Basic functionality is available,
@@ -24,11 +25,10 @@ Armin's recent drawing layer fixups also make use of it), which
 resides in /graphics/basegfx. From these modules, six libraries are
 currently delivered, namely vclcanvas.uno.dll, javacanvas.jar,
 directxcanvas.uno.dll, canvastools680mi.dll, cppcanvas680mi.dll, and
-basegfx680mi.dll. 
+basegfx680mi.dll.
 
 
-The new OOo slideshow engine
-============================
+== The new OOo slideshow engine ==
 
 The new OpenOffice.org slideshow engine will replace the current
 Impress-embedded presentation framework with a fully independent UNO
diff --git a/comphelper/README b/comphelper/README
new file mode 100644
index 000000000000..940d514bcf6a
--- /dev/null
+++ b/comphelper/README
@@ -0,0 +1 @@
+GUI-related helper classes
diff --git a/cppcanvas/README b/cppcanvas/README
new file mode 100644
index 000000000000..246cb2d62838
--- /dev/null
+++ b/cppcanvas/README
@@ -0,0 +1 @@
+Helper C++ classes for [[canvas]], plus a GDIMetaFile-to-XCanvas converter.
diff --git a/dtrans/README b/dtrans/README
new file mode 100644
index 000000000000..23555bce65aa
--- /dev/null
+++ b/dtrans/README
@@ -0,0 +1 @@
+Clipboard abstraction - data transfer.
diff --git a/o3tl/README b/o3tl/README
new file mode 100644
index 000000000000..4823d6073190
--- /dev/null
+++ b/o3tl/README
@@ -0,0 +1,30 @@
+Very basic template functionality, a bit like boost or stl, but specific to LibO
+
+From [http://blog.thebehrens.net/2006/01/15/update-cow_wrapper-is-available-now/]
+The scope for o3tl is admittedly kind of ambitious, as it should contain "...very basic (template)
+functionality, comparable to what's provided by boost or stl, but specific to OOo (what comes to mind
+are e.g. stl adapters for our own data types and UNO, and stuff that could in principle be upstreamed
+to boost, but isn't as of now)."
+
+== Class overview ==
+
+[git:o3tl/inc/o3tl/cow_wrapper.hxx]
+A copy-on-write wrapper.
+
+[git:o3tl/inc/o3tl/heap_ptr.hxx]
+heap_ptr<> owns an object on the heap, which will be automatically deleted, when ~heap_ptr<>() is called.
+
+[git:o3tl/inc/o3tl/lazy_update.hxx]
+This template collects data in input type, and updates the output type with the given update functor,
+but only if the output is requested. Useful if updating is expensive, or input changes frequently, but
+output is only comparatively seldom used.
+
+[git:o3tl/inc/o3tl/range.hxx]
+Represents a range of integer or iterator values.
+
+[git:o3tl/inc/o3tl/vector_pool.hxx]
+Simple vector-based memory pool allocator.
+
+[git:o3tl/inc/o3tl/compat_functional.hxx]
+Some more templates. Contains also templates from STLport's functional header that are not part of the
+C++ standard (STLport has been replaced by direct use of the C++ STL in Libre Office).
diff --git a/padmin/README b/padmin/README
new file mode 100644
index 000000000000..9b011ef59576
--- /dev/null
+++ b/padmin/README
@@ -0,0 +1 @@
+Printer administration dialog - used lpr - obsolete with CUPS and fontconfig, but still used for some things.
diff --git a/psprint_config/README b/psprint_config/README
new file mode 100644
index 000000000000..15eb3f12c0dc
--- /dev/null
+++ b/psprint_config/README
@@ -0,0 +1,3 @@
+Contains ppds for use by psprint when not using CUPS.
+
+(CH: psprint seems to have been gone ???)
diff --git a/regexp/README b/regexp/README
new file mode 100644
index 000000000000..c670bdad09ca
--- /dev/null
+++ b/regexp/README
@@ -0,0 +1,6 @@
+This is a regexp parser.
+
+Please see my (not so?) crazy hack idea about removing it from here and the reasoning.
+
+For additional fun, this source file is part of GNU regexp which is geared towards usage in emacs,
+so if you ever wondered why LibreOffice is so great, now you know :-).
diff --git a/rsc/README b/rsc/README
new file mode 100644
index 000000000000..09e2cd594c73
--- /dev/null
+++ b/rsc/README
@@ -0,0 +1,10 @@
+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.
diff --git a/sax/README b/sax/README
new file mode 100644
index 000000000000..5bd1d1d98381
--- /dev/null
+++ b/sax/README
@@ -0,0 +1 @@
+Wrapper around expat using UNO.
diff --git a/sot/README b/sot/README
new file mode 100644
index 000000000000..2abadba76756
--- /dev/null
+++ b/sot/README
@@ -0,0 +1 @@
+Compound file storage tools code.
diff --git a/svtools/README b/svtools/README
new file mode 100644
index 000000000000..dc35c3f38702
--- /dev/null
+++ b/svtools/README
@@ -0,0 +1 @@
+Tools on top of VCL. Common dialogs, file and print dialogs, wizards, vcl filters, lots of helper code.
diff --git a/toolkit/README b/toolkit/README
new file mode 100644
index 000000000000..960e22a1f033
--- /dev/null
+++ b/toolkit/README
@@ -0,0 +1 @@
+Abstract windowing thing, UNO implementations of windows stuff so that it can be used from Basic.
diff --git a/tools/README b/tools/README
new file mode 100644
index 000000000000..990aff89a55c
--- /dev/null
+++ b/tools/README
@@ -0,0 +1 @@
+Predates sal - string etc . functions, url manip, stream stuff, polygons, etc.
diff --git a/ucbhelper/README b/ucbhelper/README
new file mode 100644
index 000000000000..ff3d49b0b8f6
--- /dev/null
+++ b/ucbhelper/README
@@ -0,0 +1 @@
+C++ wrappers to help make using content providers easy.
diff --git a/unotools/README b/unotools/README
new file mode 100644
index 000000000000..bac492a83105
--- /dev/null
+++ b/unotools/README
@@ -0,0 +1 @@
+Helpers for C++ use of UNO.
diff --git a/vcl/README b/vcl/README
index 97ff76a70506..81afba0e0ef4 100644
--- a/vcl/README
+++ b/vcl/README
@@ -1,3 +1,5 @@
+Visual Components Library is responsible for the widgets (windowing, buttons, controls, etc.) operating system abstraction, including basic rendering (e.g. the output device).
+
 Welcome to the Visual Class Libraries (vcl) code
 
 source/