Documentation fixes.

[virt-hostinfo.git] / README

diff --git a/README b/README
index e69de29..00fab3e 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,67 @@
+virt-hostinfo
+Copyright (C) 2009 Red Hat Inc.
+----------------------------------------------------------------------
+
+This is a project designed to allow controlled access to host
+information from virtual machines.  It is proposed as a new feature
+for Fedora 12, and you can read more about it on this web page:
+
+http://fedoraproject.org/wiki/Features/Hostinfo
+
+
+Requirements
+----------------------------------------------------------------------
+
+- C compiler
+
+- APR (Apache Portable Runtime) 1.2.7 (1.3 preferred)
+
+- Perl
+
+- pod2man and other perldoc tools
+  * these are usually supplied with Perl
+
+- libvirt & development tools
+
+- Perl module Sys::Virt
+
+- Perl module XML::XPath
+
+
+Build
+----------------------------------------------------------------------
+
+On the host:
+
+  ./configure
+  make
+  sudo make install
+
+There is nothing to build or install in the guest.
+
+
+Host configuration
+----------------------------------------------------------------------
+
+You can edit the text configuration files under /etc/hostinfod by
+hand.  Please read the hostinfo(8) manual page.
+
+For graphical configuration, use virt-manager.
+
+To create new guests with access to host information, use
+virt-install.
+
+
+Accessing host information from guests
+----------------------------------------------------------------------
+
+No special software is required inside the guest.  Simply connect to
+the serial port (usually, but not always, /dev/ttyS1 or COM2) using
+your favorite serial terminal software and send commands.
+
+The protocol is a simple, line-based, text protocol.  No special
+libraries are needed to use it from programs or by hand.  The commands
+that you can send are documented in the hostinfo-protocol(5) manual
+page.
+
+For troubleshooting, see hostinfo(8) manual page.