Document how compositor and clients are supposed to work.debian-experimental

That goes into the /usr/share/doc/wayland-demos/README.Debian file.

2 files changed, 23 insertions, 0 deletions

diff --git a/debian/README.Debian b/debian/README.Debian
new file mode 100644
index 0000000..bf8427c
--- /dev/null
+++ b/debian/README.Debian
@@ -0,0 +1,21 @@
+Wayland for Debian
+------------------
+
+  * This package contains a sample compositor, along with a few demo
+    clients.
+  * The compositor (wayland-compositor) can be run from within X, where it
+    behaves like an X client; or it can be run from the console, on top of
+    the DRM/KMS layer.
+  * The wayland socket is stored in the directory specified in the
+    XDG_RUNTIME_DIR variable, falling back to te current directory if that
+    variable isn't set.
+  * When clients are run, the wayland socket is found using the same
+    mechanism (XDG_RUNTIME_DIR, with current directory as fallback).
+  * Since clients have very generic names, they are shipped in the
+    /usr/lib/wayland/bin directory. A wrapper (wayland-run) makes it
+    possible to run the demo clients without having to enter the full
+    path: “wayland-run demo” runs “/usr/lib/wayland/bin/demo”; if there's
+    no argument, or if the specified demo doesn't exist, a random demo
+    client is started instead.
+
+ -- Cyril Brulebois <kibi@debian.org>  Mon, 20 Jun 2011 23:49:15 +0200
diff --git a/debian/changelog b/debian/changelog
index 6f1fee6..5ade641 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -11,5 +11,7 @@ wayland-demos (0.1.0~0-1) UNRELEASED; urgency=low
     happens.
   * Manually ship all demo clients under /usr/lib/wayland/bin, and ship
     a shell wrapper to run them: wayland-run.
+  * Document how compositor and clients are supposed to work in the
+    /usr/share/doc/wayland-demos/README.Debian file.
 
  -- Cyril Brulebois <kibi@debian.org>  Thu, 16 Jun 2011 14:08:14 +0200