explicitly list device usage in README

This commit is contained in:
Csaba Kiraly 2016-11-24 12:00:20 +01:00
parent 57a69657c8
commit e8bf195453
1 changed files with 2 additions and 0 deletions

View File

@ -2,8 +2,10 @@
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.
`Usage: ./pishrink [-s] imagefile.img [newimagefile.img]`
./pishrink [-s] </dev/sd_device>`
If the `-s` option is given the script will skip the autoexpanding part of the process. If you specify the `newimagefile.img` parameter, the script will make a copy of `imagefile.img` and work off that. You will need enough space to make a full copy of the image to use that option.
If a device file (e.g. /dev/mmcblk0) is given as parameter, it will shrink the image directly on the SD card.
## Example ##
```bash