build: don't tell "make clean" to remove my '~' backup files

[libguestfs.git] / README

diff --git a/README b/README
index 50d2145..252e595 100644 (file)
--- a/README
+++ b/README
@@ -16,7 +16,7 @@ LVs, what filesystem is in each LV, etc.).  It can also run commands
 in the context of the guest.  Also you can access filesystems over FTP.
 
 Libguestfs is a library that can be linked with C and C++ management
-programs (or management programs written in OCaml, Perl, Python or Ruby).
+programs (or management programs written in OCaml, Perl, Python, Ruby or Java).
 You can also use it from shell scripts or the command line.
 
 Libguestfs was written by Richard W.M. Jones (rjones@redhat.com).
@@ -28,7 +28,8 @@ For discussion please use the fedora-virt mailing list:
 Requirements
 ----------------------------------------------------------------------
 
-- recent QEMU with vmchannel support
+- recent QEMU >= 0.10 with vmchannel support
+  http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
 
 - febootstrap >= 1.5
 
@@ -52,6 +53,9 @@ also to build the OCaml bindings
 
 - (Optional) Ruby, rake if you want to build the ruby bindings
 
+- (Optional) Java, JNI, jpackage-utils if you want to build the java
+bindings
+
 Running ./configure will check you have all the requirements installed
 on your machine.
 
@@ -78,6 +82,26 @@ these commands as root:
   make install
 
 
+Note on using KVM
+----------------------------------------------------------------------
+
+If you are using x86-64, then by default the configure script will
+look for qemu-kvm (KVM support).  You will need a reasonably recent
+processor for this to work.  KVM is much faster than using plain QEMU.
+
+You may also need to enable KVM support for non-root users, by following
+these instructions:
+
+  http://www.linux-kvm.org/page/FAQ#How_can_I_use_kvm_with_a_non-privileged_user.3F
+
+On some systems, this will work too:
+
+  chmod o+rw /dev/kvm
+
+On some systems, the chmod will not survive a reboot, and you will
+need to make edits to the udev configuration.
+
+
 Notes on cross-architecture support
 ----------------------------------------------------------------------