From 7515ee5631aff6ee2e05303878be0466da197afc Mon Sep 17 00:00:00 2001 From: framp Date: Sun, 12 Jan 2020 10:23:22 +0100 Subject: [PATCH] Updated README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e2ae0f4..78fb10b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # PiShrink # PiShrink is a bash script that automatically shrink a pi image that will then resize to the max size of the SD card on boot. This will make putting the image back onto the SD card faster and the shrunk images will compress better. +In addition the shrinked image can be compressed with gzip, pigz, xz or pxz to create an even smaller image. ## Usage ## ``` sudo pishrink.sh [-sdrzh] imagefile.img [newimagefile.img] -s: Skip autoexpand - -i TOOL: Zip tool to use to compress image. TOOLS can be one of gtip pigz xz pxz (Default: gzip) + -i TOOL: Zip tool to use to compress image. TOOLS can be one of gzip pigz xz pxz (Default: gzip) -d: Debug mode on -r: Use advanced repair options -z: Compress image after shrinking @@ -18,8 +19,7 @@ If you specify the `newimagefile.img` parameter, the script will make a copy of * `-s` will skip the autoexpanding part of the process. * `-d` will create a logfile `pishrink.log` which may help for problem analysis. * `-r` will attempt to repair the filesystem if regular repairs fail -* `-z` will Gzip compress the image after shrinking. The `.gz` extension will be added to the filename. - +* `-z` will compress the image after shrinking using gzip, pigz, xz or pxz. Default is `gzip`. `.gz` or `.xz` extension will be added to the filename. ## Prerequisites ## If you are trying to shrink a [NOOBS](https://github.com/raspberrypi/noobs) image it will likely fail. This is due to [NOOBS partitioning](https://github.com/raspberrypi/noobs/wiki/NOOBS-partitioning-explained) being significantly different than Raspbian's. Hopefully PiShrink will be able to support NOOBS in the near future.