add readme

1 files changed, 39 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..af77082
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+This is a bunch of utilities for xen hosts.  Some useful are for
+admins, some for developers, some are just experiental and not
+very useful at all ...
+
+xenwatch
+  First application which also gave the name to the whole package.
+  gtk application, lists running domains with some properties, allows
+  to connect to text console or vnc display.  Uses xenstore, thus
+  does see active domains only.
+
+xenscreen
+  Attaches xen domain consoles to screen windows.  Great tool for
+  text mode hackers and screen users.  This one can run either using
+  xenstore or using libvirt.
+
+xenstore
+  gtk xenstore browser.  If you don't know what xenstore is you don't
+  need it.
+
+xenlog
+  Log xenstore activity to stdout.
+
+vnc-client
+  xenwatch builtin vnc client as standalone application.
+
+mdns-publish-xendom
+  Publish xen uuid and domid via multicast dns.  Runs inside your
+  xen guests aka domUs.  Doesn't notice save/restore and migration,
+  due to xenstore watches not working inside guests, thus it isn't
+  terribly useful ...
+
+mdns-publish-vnc
+  Publish vnc ports of xen guests via multicast dns.  Unconditionally,
+  even when listening on 127.0.0.1 only (default) and thus you can't
+  connect from outside anyway ...
+
+mdns-browser
+  Simple multicast dns service browser.
+