X-Git-Url: https://git.siccegge.de//index.cgi?p=forks%2Fvmdebootstrap.git;a=blobdiff_plain;f=README;h=2b58ccfc75576e39f9b8f9a527c2e65f4e94bde9;hp=404db87512246c99dc8dbd2513d9a1fffb485e0a;hb=HEAD;hpb=cb04e42938bb06d3168072729382e0ad692aef47

diff --git a/README b/README
index 404db87..2b58ccf 100644
--- a/README
+++ b/README
@@ -58,7 +58,59 @@ In order to use vmdebootstrap, you'll need a few things:
 * mbr
 * kpartx
 * python-cliapp (see http://liw.fi/cliapp/)
+* python-distro-info
 
+Running vmdebootstrap from git
+------------------------------
+
+$ sudo PYTHONPATH=. ./bin/vmdebootstrap
+
+This has changed slightly with version 1.0 with the need for
+PYTHONPATH to reference the module approach for support handlers.
+
+pylint
+------
+
+vmdebootstrap uses pylint and contains comments to disable certain
+pylint checks in certain areas. pylint compatibility will make it
+easier to accept patches, just follow the existing pattern
+of pylint usage. pylint is far from perfect but can be helpful.
+
+Testing UEFI support
+--------------------
+
+There is EFI firmware available to use with QEMU when testing images
+built using the UEFI support, but this software is in Debian non-free
+due to patent concerns. If you choose to use it to test UEFI builds,
+a secondary change is also needed to symlink the provided OVMF.fd to
+the file required by QEMU: bios-256k.bin and then tell QEMU about the
+location of this file with the -L option:
+
+$ qemu-system-x86_64 -L /usr/share/ovmf/ -machine accel=kvm \
+  -m 4096 -smp 2 -drive file=amd64.img,format=raw
+
+Note the use of -drive file=<img>,format=raw which is needed for newer
+versions of QEMU.
+
+The vmextract helper
+--------------------
+
+Once the image is built, various files can be generated or modified
+during the install operations and some of these files can be useful
+when testing the image. One example is the initrd built by the process
+of installing a Debian kernel. Rather than having to mount the image
+and copy the files manually, the vmextract helper can do it for you,
+without needing root privileges.
+
+$ /usr/share/vmdebootstrap/vmextract.py --verbose \
+  --image bbb/bbb-debian-armmp.img --boot \
+  --path /boot/initrd.img-3.14-2-armmp \
+  --path /lib/arm-linux-gnueabihf/libresolv.so.2
+
+This uses python-guestfs (a Recommended package for vmdebootstrap) to
+prepare a read-only version of the image - in this case with the /boot
+partition also mounted - and copies files out into the current working
+directory.
 
 Legalese
 --------