Add .gitignore file for git.

[virt-p2v.git] / README

diff --git a/README b/README
index 30afc68..9801015 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,89 @@
-$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/
+
+Support
+----------------------------------------------------------------------
+
+Please send all queries, patches, bug reports etc. to the
+et-mgmt-tools mailing list:
+
+       http://www.redhat.com/mailman/listinfo/et-mgmt-tools
+
+
+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 (in Fedora the package is called 'livecd-tools')
+ * rpmbuild (in Fedora package rpm-build)
+ * ocaml, ocaml-findlib, ocaml-extlib, ocaml-pcre, ocaml-xml-light,
+   ocaml-newt, ocaml-libvirt, ocaml-fileutils, ocaml-gettext,
+   ocaml-gettext-devel (all in Fedora)
+ * qemu and/or KVM (only for testing)
+
+Then:
+
+       ./configure --help
+       ./configure
+       make
+
+Then:
+
+       make rpm        builds the virt-p2v RPM
+       make build      (AS ROOT) builds an ISO image
+                       called virt-p2v-$VERSION.iso
+
+Other useful commands:
+
+        make man        Build manual page
+        make pxe       Make a PXE-boot image in tftpboot/ subdirectory
+
+Burn the image on to a CD using standard tools.
+
+
+Testing
+----------------------------------------------------------------------
+
+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
+
+
+Serial console
+----------------------------------------------------------------------
 
-Copyright (C) 2007 Red Hat Inc.
+With livecd-tools >= 018, the CD should enable the serial console
+(ttyS0, 9600 8N1).
 
+You can test this with:
+  make boot [...] SERIAL=yes