Skip to content

Commit 60a3a2e

Browse files
sonnypethanjli
authored andcommitted
doc: Replace references to img.gz with img.xz
> (Release) SD card images are now released with xz compression (as .img.xz files) rather than gzip compression (as .img.gz files). See https://docs.planktoscope.community/reference/software/changelog/#v202400-beta1-2024-06-24
1 parent aa7e911 commit 60a3a2e

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

documentation/docs/community/contribute/tips-and-tricks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ sudo dd bs=1M if=/dev/device status=progress | xz > sdcard.img.xz
3333

3434
```sh
3535
# restore an image file from your computer onto the SD card
36-
xzcat sdcard.img.xz | sudo dd bs=1M of=/dev/mmcblk0 status=progress
36+
xzcat sdcard.img.xz | sudo dd bs=1M of=/dev/device status=progress
3737
```
3838

3939
See also the operating guide [SD Card Cloning](../../operation/clone-sd.md).

documentation/docs/operation/clone-sd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,10 @@ In order to make the SD card practical to share, you should shrink and compress
105105
cd /some/path/here
106106
wget https://raw.githubusercontent.com/Drewsif/PiShrink/master/pishrink.sh
107107
chmod +x pishrink.sh
108-
sudo ./pishrink.sh -za image-name-here.img
108+
sudo ./pishrink.sh -Za image-name-here.img
109109
```
110110

111-
If you had set up the PlanktoScope software on a Raspberry Pi OS Lite image, you should get a `image-name-here.img.gz` file which is at least 2 GB in size.
111+
If you had set up the PlanktoScope software on a Raspberry Pi OS Lite image, you should get a `image-name-here.img.xz` file which is at least 2 GB in size.
112112

113113
## Use the SD card image
114114

documentation/docs/setup/software/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In order to install the PlanktoScope software, you will first need to choose an
1010

1111
## Choosing an SD card image
1212

13-
PlanktoScope SD card image files are identified with a version number as well as a hardware configuration tag - for example, the SD card image file named `planktoscope-v2024.0.0+planktoscopehat.img.gz` is for v2020.0.0 of the PlanktoScope OS, configured to work with versions of the PlanktoScope hardware based on the custom PlanktoScope HAT (rather than the Adafruit Stepper Motor HAT). Thus, you will need to choose both a version number (e.g. v2023.9.0) and a hardware configuration (e.g. `planktoscopehat`).
13+
PlanktoScope SD card image files are identified with a version number as well as a hardware configuration tag - for example, the SD card image file named `planktoscope-v2024.0.0+planktoscopehat.img.xz` is for v2020.0.0 of the PlanktoScope OS, configured to work with versions of the PlanktoScope hardware based on the custom PlanktoScope HAT (rather than the Adafruit Stepper Motor HAT). Thus, you will need to choose both a version number (e.g. v2023.9.0) and a hardware configuration (e.g. `planktoscopehat`).
1414

1515
### PlanktoScope OS versions
1616

documentation/docs/setup/software/nonstandard-install.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ Next, you will need to write your downloaded Raspberry Pi OS image file to your
4343

4444
To use a graphical application to write the image file to your microSD card, you can install the Raspberry Pi imager. Download the latest version of the [Raspberry Pi Imager](https://www.raspberrypi.com/software/), install it, and start it. Select the Raspberry Pi OS image file (likely a `.img`, `.img.gz`, or `.img.xz` file) you just downloaded, and select the SD card you want to write the Raspberry Pi OS image to. Review your selections and click the appropriate button to begin writing the Raspberry Pi OS image to the SD card. The process should take several minutes.
4545

46-
If you'd instead prefer to write the image file to your microSD card from a command-line tool, you could instead use a tool like `ddrescue` on a Debian-based system, e.g. as follows:
46+
If you'd instead prefer to write the `.xz.img` image file to your microSD card from a command-line tool, you can use the following command
4747

48-
```
49-
gunzip planktoscope-v2.3-final.img.gz
50-
sudo ddrescue planktoscope-v2.3-final.img /dev/mmcblk0 --force
48+
```sh
49+
xzcat sdcard.img.xz | sudo dd bs=1M of=/dev/mmcblk0 status=progress
5150
```
5251

53-
Warning: be extremely careful when choosing the storage medium and ensure that you are writing the OS image file to the device which actually corresponds to the correct microSD card. Once the image has been written, data previously on the device will be lost and impossible to recover.
52+
!!! warning
53+
Be extremely careful when choosing the storage medium and ensure that you are writing the OS image file to the device which actually corresponds to the correct microSD card. Once the image has been written, data previously on the device will be lost.
5454

5555
### Configure your Raspberry Pi
5656

software/distro/setup/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ chmod +x pishrink.sh
2525
sudo ./pishrink.sh -za image-name-here.img
2626
```
2727

28-
If you had set up the PlanktoScope software on a Raspberry Pi OS Lite image, you should get a `image-name-here.img.gz` file which is approximately 1 GB in size.
28+
If you had set up the PlanktoScope software on a Raspberry Pi OS Lite image, you should get a `image-name-here.img.xz` file which is approximately 1 GB in size.

0 commit comments

Comments
 (0)