Update documentation.

[virt-tools.git] / README

diff --git a/README b/README
index e69de29..d06586c 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,48 @@
+virt-tools - virtual machine info and statistics
+Copyright (C) Red Hat Inc. 2009
+----------------------------------------------------------------------
+
+This README file is just an overview of the available documentation
+for virt-tools.
+
+To compile from source, see 'INSTALL'.
+
+To use and understand virt-tools, also including how it works and
+security considerations, see 'docs/virt-tools.pod' (which is installed
+as virt-tools(8) manpage).
+
+To hack on the code, see 'HACKING'.
+
+
+What is in each directory
+----------------------------------------------------------------------
+
+'[guest]' denotes something that is installed in the guest, and
+'[host]' denotes something that is install in the host.
+
+daemon/                [guest]
+  On Linux/Unix, this contains the configuration used to start the
+  virt-tools service *in the guest*.  Note that the service is
+  just snmpd with a modified configuration.  We don't include
+  the source for snmpd here -- that is supplied by another package
+  like net-snmp.
+
+docs/                  [guest/host]
+
+  Man pages.
+
+linux/                 [guest]
+
+  Linux-specific startup scripts for the guest.
+
+m4/
+
+  Autotools m4 macros.
+
+tools/                 [host]
+
+  Source for the client tools.
+
+windows/               [guest]
+
+  Windows-specific configuration for the guest.