Initial import.HEADmaster

1 files changed, 91 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..3833183
--- /dev/null
+++ b/README
@@ -0,0 +1,91 @@
+What is this?
+=============
+
+The thunar-desktop-plugin provides a set of desktop views for the 
+Thunar file manager. These include:
+
+  * A classic view of the personal desktop folder supporting icons 
+    for files, folders, removable media and launchers.
+
+  * A view that shows minmized windows, allows them to be modified
+    and thereby helps in managing windows and maintaining a good
+    overview of running applications.
+
+  * A simple view that simply displays a background image.
+
+All of these views support different kinds of context and application
+menus.
+
+
+Required packages
+=================
+
+thunar-desktop-plugin depends on the following packages:
+
+  * gio-2.0 >= 2.24.0
+  * glib-2.0 >= 2.24.0
+  * gobject-2.0 >= 2.24.0
+  * gthread-2.0 >= 2.24.0
+
+thunar-desktop can optionally use the following packages:
+
+  * NAME >= VERSION (FOR WHAT PURPOSE)
+
+
+Installation
+============
+
+The 'INSTALL' file contains generic installation instructions. 
+
+
+Debugging Support
+=================
+
+thunar-desktop-plugin 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 thunar-desktop-plugin to 
+    locate a bug. The build will most probably be noticably slower.
+    This is also recommended for people that want to write code for
+    thunar-desktop-plugin.
+
+  `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. 
+
+  `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
+====================
+
+thunar-desktop-plugin supports and implements the following standards
+and 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 Thunar-desktop-plugin). You will 
+need to create a bugzilla account for yourself first.
+
+Please read the HACKING file for information on where to send
+changes or bugfixes for this package.