Reorder Readme
This commit is contained in:
parent
2d2c4d5802
commit
551e9950ac
20
README.md
20
README.md
|
@ -6,6 +6,16 @@ PiShrink is a bash script that automatically shrink a pi image that will then re
|
||||||
|
|
||||||
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 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.
|
||||||
|
|
||||||
|
## Prerequisites ##
|
||||||
|
If using Ubuntu, you will likely see an error about `e2fsck` being out of date and `metadata_csum`. The simplest fix for this is to use Ubuntu 16.10 and up, as it will save you a lot of hassle in the long run.
|
||||||
|
|
||||||
|
## Installation ##
|
||||||
|
```bash
|
||||||
|
wget https://raw.githubusercontent.com/Drewsif/PiShrink/master/pishrink.sh
|
||||||
|
chmod +x pishrink.sh
|
||||||
|
sudo mv pishrink.sh /usr/local/bin
|
||||||
|
```
|
||||||
|
|
||||||
## Example ##
|
## Example ##
|
||||||
```bash
|
```bash
|
||||||
[user@localhost PiShrink]$ sudo pishrink.sh pi.img
|
[user@localhost PiShrink]$ sudo pishrink.sh pi.img
|
||||||
|
@ -30,16 +40,6 @@ The filesystem on /dev/loop1 is now 773603 blocks long.
|
||||||
Shrunk pi.img from 30G to 3.1G
|
Shrunk pi.img from 30G to 3.1G
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installation ##
|
|
||||||
```bash
|
|
||||||
wget https://raw.githubusercontent.com/Drewsif/PiShrink/master/pishrink.sh
|
|
||||||
chmod +x pishrink.sh
|
|
||||||
sudo mv pishrink.sh /usr/local/bin
|
|
||||||
```
|
|
||||||
|
|
||||||
## Prerequisites ##
|
|
||||||
If using Ubuntu, you will likely see an error about `e2fsck` being out of date and `metadata_csum`. The simplest fix for this is to use Ubuntu 16.10 and up, as it will save you a lot of hassle in the long run.
|
|
||||||
|
|
||||||
## Contributing ##
|
## Contributing ##
|
||||||
If you find a bug please create an issue for it. If you would like a new feature added, you can create an issue for it but I can't promise that I will get to it.
|
If you find a bug please create an issue for it. If you would like a new feature added, you can create an issue for it but I can't promise that I will get to it.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue