Manual page with centralised documentation.

[virt-p2v.git] / README

diff --git a/README b/README
index 1e258c2..d03ce0a 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,59 @@
+$Id$
+
 virt-p2v : P2V ("physical to virtual") migration tool
 ----------------------------------------------------------------------
 
-Written by:
-  Richard W.M. Jones <rjones@redhat.com>
+Written by Richard W.M. Jones <rjones@redhat.com>
+
+Copyright (C) 2007-2008 Red Hat Inc.
+
+       http://et.redhat.com/~rjones/virt-p2v/
+
+
+Binaries
+----------------------------------------------------------------------
+
+Binaries are available from the website (live CD images which can be
+burned directly to a CD and booted on the p2v candidate machine).
+
+       http://et.redhat.com/~rjones/virt-p2v/download.html
+
+
+Usage
+----------------------------------------------------------------------
+
+Please read the manual page:
+
+       man virt-p2v
+or     make man; nroff -man virt-p2v.1 | less
+or     http://et.redhat.com/~rjones/virt-p2v/virt-p2v.1.html
+
+
+Building
+----------------------------------------------------------------------
+
+Requirements:
+
+ * livecd-creator (on Fedora the package is 'livecd-tools')
+ * ocaml, ocaml-extlib, ocaml-pcre, ocaml-xml-light (all in Fedora)
+ * qemu and/or KVM (only for testing)
+
+(1) Edit Makefile - there is some general configuration at the
+    top which you may want to change.
+
+(2) 'make build' will build an ISO image called virt-p2v-$VERSION.iso
+
+(3) Burn the image on to a CD using standard tools.
+
+
+Testing
+----------------------------------------------------------------------
 
-Copyright (C) 2007 Red Hat Inc.
+If you want to test the live CD without actually P2V-ing a real
+server, then you can run the ISO directly in qemu.  (To do any sort of
+realistic testing you will also need an operating system image,
+eg. from /var/lib/xen/images, to experiment with).  For example:
 
+  $ cp /var/lib/xen/images/rhel5gax32fv.img .
+  $ make boot HDA=rhel5gax32fv.img
+  qemu -m 512 -cdrom virt-p2v-0.1.iso -boot d -hda rhel5gax32fv.img