# HG changeset patch
# User Heiko Schlittermann (JUMPER) <hs@schlittermann.de>
# Date 1360105469 -3600
# Node ID 977e53d08eac0401e7953c27cb325054c025fd17
# Parent  518b0a072abea33013678b98c1d42c3423136869
added README for the impatient

diff -r 518b0a072abe -r 977e53d08eac README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Wed Feb 06 00:04:29 2013 +0100
@@ -0,0 +1,47 @@
+Guide to the impatient user
+===========================
+
+Install the package
+-------------------
+
+    # perl Build.PL
+
+    (optional step)
+    # ./Build prereq_report
+
+    ./Build install
+
+Create your first image
+-----------------------
+
+NOTE: The device you're imaging must not be busy during
+image creation. Other your image will be unusable!
+
+The preferred way to get an idle device is using LVM snapshots:
+
+    # lvcreate -s -L 1G -n lvol00-snap vg00/lvol00
+
+    (optional - check the filesystem)
+    # fsck -y /dev/mapper/vg00/lvol00-snap
+
+    # imager save /dev/mapper/vg00/lvol00-snap /path/to/backup
+
+Restore your image
+------------------
+
+For a full restore:
+
+    # imager restore /path/to/backup/idx/HOST/DEVICE/IMAGE-name > image
+
+If you need just parts of your image:
+
+    # imager fuse /path/to/backup/ /mnt
+
+Now you may browse the images below /mnt/. To select just some files -
+loop mount such an image and restore the files you need:
+
+    # mount -o loop /mnt/…/image /media/xxx
+
+Happy landings….
+-- 
+Heiko Schlittermann <hs@schlittermann.de>