[Xfce4-commits] <tumbler:master> Add Philip to the authors. Update README.

[Jannis Pohlmann]

Updating branch refs/heads/master
         to f4595d8c03cc4ada3b40b24cf337c35385f20a7d (commit)
       from 82716fedd1eaf7312b5f6991d336e3decc2f66a4 (commit)

commit f4595d8c03cc4ada3b40b24cf337c35385f20a7d
Author: Jannis Pohlmann <jannis at xfce.org>
Date:   Mon Dec 7 12:23:55 2009 +0100

    Add Philip to the authors. Update README.

 AUTHORS |    1 +
 README  |   94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 95 insertions(+), 0 deletions(-)

diff --git a/AUTHORS b/AUTHORS
index c40ddc1..30070c8 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1 +1,2 @@
 Jannis Pohlmann <jannis at xfce.org>
+Philip Van Hoof <philip at codeminded.be>
diff --git a/README b/README
index e69de29..c338921 100644
--- a/README
+++ b/README
@@ -0,0 +1,94 @@
+What is this?
+=============
+
+Tumbler is a D-Bus service for applications to request thumbnails for
+various URI schemes and MIME types. It is an implementation of the 
+thumbnail management D-Bus specification described on 
+
+  http://live.gnome.org/ThumbnailerSpec
+
+written in an object-oriented fashion using GLib and GObject. Its 
+modular architecture makes it very flexible and useful in many
+situations. It provides plugin interfaces for extending the URI schemes
+and MIME types for which thumbnails can be generated as well as
+for replacing the storage backend that is used to store the thumbnails
+on disk. Tumbler's functionality can also be extended via specialized
+thumbnailer services implemented in accordance to the thumbnail 
+management D-Bus specification.
+
+
+Required packages
+=================
+
+Tumbler depends on the following packages:
+
+  * glib-2.0 >= 2.16.0
+  * gio-2.0 >= 2.16.0
+  * gthread-2.0 >= 2.16.0
+  * dbus-1 >= 1.0.0
+  * dbus-glib-1 >= 0.72
+
+Tumbler can optionally use the following packages:
+
+  * gdk-pixbuf-2.0 >= 2.14.0 (for a pixbuf thumbnailer plugin) 
+  * FreeType 2.x (for a font thumbnailer plugin)
+  * libpng >= 1.2.0 (for the Thumbnail Managing Standard storage 
+    backend, gdk-pixbuf-2.0 is also required for this)
+
+
+Installation
+============
+
+The 'INSTALL' file contains generic installation instructions. 
+
+
+Debugging Support
+=================
+
+Tumbler currently supports four different levels of debugging support, 
+which can be setup using the configure flag `--enable-debug' (check the 
+output of `configure --help'):
+
+  `full'  Use this if you want to debug Tumbler to locate a bug. The
+    build will most probably be noticably slower. This is also
+    recommended for people that want to develop Tumbler stuff.
+
+  `yes'  This is the default for git snapshot builds. It adds all
+    kinds of checks to the code, and is therefore likely to run
+    slower. Use this if you want to develop for Tumbler (e.g.
+    writing Tumbler extensions and such).
+
+  `minimum'  This is the default for release builds, and presents the
+    recommended behaviour.
+
+  `no'  Disables all sanity checks. Don't use this unless you know
+    exactly what you do.
+
+
+Standards compliance
+====================
+
+Tumbler supports and implements the following standards/specifications:
+
+  * XDG Base Directory Specification
+    http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
+
+  * Thumbnail Managing Standard
+    http://jens.triq.net/thumbnail-spec/
+
+  * Thumbnail Management D-Bus Specification
+    http://live.gnome.org/ThumbnailerSpec
+
+  * File URI Specification
+    http://www.freedesktop.org/wiki/Specifications/file-uri-spec
+
+
+How to report bugs?
+===================
+
+Bugs should be reported to the Xfce bug tracking system 
+(http://bugzilla.xfce.org, product Tumbler). You will need to
+create a bugzilla account for yourself first.
+
+Please read the HACKING file for informaiton on where to send
+changes or bugfixes for this package.