Using save/ to keep downloads and partial progress

[rrq/tiniest.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index 95c37f695cf5e4b25f7cefc068cfbac2651b9ff1..cd08bdf796cc33beedadf1f14d1465d8dc72df6d 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -5,13 +5,19 @@ with a single, common syslinux boot configuration used for both legacy
 bios and UEFI bios.
 
 The script +mkit.sh+ prepares such a +bootimage.raw+ and the script
-+vm.sh+ runs a Qemu VM for testing it.
++vm.sh+ runs a Qemu VM for testing it. In addition, the script
++packit.sh+ runs xorriso to prepare an ISO with that boot image, to
+boot either as cdrom for legacy bios or with EFI partition with for
+UEFI bios.
 
-.Program used by mkit.sh and vm.sh
+.Program/packages used by mkit.sh, vm.sh and packiso.sh
 ----
-ar awk bash cat chmod cp dd depmod dpkg fakechroot fakeroot find ln
-mcopy mkdir mke2fs mkfs.fat mmd rm sed sfdisk syslinux tar wget xzcat
-qemu-system-x86_64
+ar from binutils; gawk (as awk) from gawk; cat, chmod, cp, ln and rm
+from coreutils; depmod from kmod; fakeroot from fakeroot; find from
+findutils; mcopy, mkdir and mmd from mtools; mke2fs from e2fsprogs;
+mkfs.fat from dosfstools; sed from sed; sfdisk from fdisk; syslinux
+from syslinux; tar from tar; wget from wget; xzcat from xz-utils;
+qemu-system-x86_64 from qemu-system-x86; and xorriso from xorriso
 ----
 
 * Kernel version +$VERSION+ is obtained from the linux-image-amd64
@@ -19,21 +25,47 @@ qemu-system-x86_64
 
 .Downloaded packages
 ----
-busybox-static linux-image-$VERION
-syslinux syslinux-common syslinux-efi syslinux-utils
+busybox-static linux-image-$VERSION
+syslinux syslinux-common syslinux-efi syslinux-utils isolinux
 ----
 
-.How to build
+'''
+
+.Hown to build bootimage.raw
 ----
 $ ./mkit.sh
 ----
+Note that building will use +http_proxy+ if it's set.
+
+.How to package bootimage.raw into tiniest.iso
+----
+$ ./packiso.sh
+----
+
+'''
 
-.How to test legacy bios boot
+.How to test hard disk legacy bios boot
 ----
 $ ./vm.sh
 ----
+Then push <escape> to select boot device menu; number 2 is
++bootimage.raw+.
 
-.How to test UEFI bios boot
+.How to test cdrom legacy bios boot
+----
+$ ISO=y ./vm.sh
+----
+Then push <escape> to select boot device menu; number 4 is
++tiniest.iso+.
+
+.How to test hard disk UEFI bios boot
 ----
 $ EFI=yes ./vm.sh
 ----
+Note that this uses +bootimage.raw+ as second disk.
+
+.How to test cdrom UEFI bios boot
+----
+$ EFI=yes ISO=y ./vm.sh
+----
+Note that this uses +tiniest.iso+ as second disk.