Skip to content

Commit 71c60d5

Browse files
committed
Update documentation
Signed-off-by: Renê de Souza Pinto <[email protected]>
1 parent cea2d41 commit 71c60d5

File tree

2 files changed

+8
-52
lines changed

2 files changed

+8
-52
lines changed

DEVELOPER.md

Lines changed: 7 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ sudo apt install --no-install-recommends build-essential cmake git libgnutls28-d
2020
#### Get the source
2121

2222
```sh
23-
git clone --depth 1 https://github.com/raspberrypi/rpi-imager
23+
git clone --depth 1 https://github.com/zededa/zflash
2424
```
2525

2626
#### Build Qt
@@ -29,13 +29,13 @@ git clone --depth 1 https://github.com/raspberrypi/rpi-imager
2929
sudo ./build-qt.sh
3030
```
3131

32-
This will build and install the version of Qt preferred for Raspberry Pi Imager into /opt/Qt/<version>. You must use `sudo` for the installation step to complete.
32+
This will build and install the version of Qt preferred for ZFlash into /opt/Qt/<version>. You must use `sudo` for the installation step to complete.
3333

3434
#### Build the AppImage
3535

3636
```sh
3737
./create_appimage.sh
38-
./Raspberry_Pi_Imager-*.AppImage
38+
./ZFlash-*.AppImage
3939
```
4040

4141
### Windows
@@ -50,7 +50,7 @@ This will build and install the version of Qt preferred for Raspberry Pi Imager
5050

5151
#### Building
5252

53-
Building Raspberry Pi Imager on Windows is best done with Visual Studio Code (or a derivative).
53+
Building ZFlash on Windows is best done with Visual Studio Code (or a derivative).
5454

5555
- Open Visual Studio Code, and select 'Clone repo'. Give it the git url of this project.
5656
- Open the CMake plugin settings, and set the following Configure Args:
@@ -73,7 +73,7 @@ Building Raspberry Pi Imager on Windows is best done with Visual Studio Code (or
7373

7474
#### Building
7575

76-
Building Raspberry Pi Imager on Windows is best done with Visual Studio Code (or a derivative).
76+
Building ZFlash on Windows is best done with Visual Studio Code (or a derivative).
7777

7878
- Open Visual Studio Code, and select 'Clone repo'. Give it the git url of this project.
7979
- Open the CMake plugin settings, and set the following Configure Args:
@@ -83,25 +83,8 @@ Building Raspberry Pi Imager on Windows is best done with Visual Studio Code (or
8383
- `-DIMAGER_NOTARIZE_APP=ON` - to enable automatic notarization for distribution to others.
8484
- `-DIMAGER_NOTARIZE_KEYCHAIN_PROFILE=notarytool-password` - specify the name of the keychain item containing your Apple ID credentials for notarizing.
8585
- In the CMake plugin tab, ensure you have selected the `MinSizeRel` variant if you intend to distribute to others.
86-
- In the CMake plugin tab, select the 'rpi_imager' target, and build it
87-
- Your resultant DMG will be located at `$WORKSPACE\build\Raspberry Pi Imager-$VERSION.dmg`
88-
89-
### Linux embedded (netboot) build
90-
91-
The embedded build runs under a minimalistic Linux distribution compiled by buildroot.
92-
To build:
93-
94-
- You must be running a Linux system, and have the buildroot dependencies installed as listed in the buildroot manual: https://buildroot.org/downloads/manual/manual.html#requirement
95-
- Run:
96-
97-
```sh
98-
cd rpi-imager/embedded
99-
./build.sh
100-
```
101-
102-
The result will be in the "output" directory.
103-
The files can be copied to a FAT32 formatted SD card, and inserted in a Pi for testing.
104-
If you would like to build a (signed) netboot image there are tools for that at: https://github.com/raspberrypi/usbboot/tree/master/tools
86+
- In the CMake plugin tab, select the 'zflash' target, and build it
87+
- Your resultant DMG will be located at `$WORKSPACE\build\ZFlash Imager-$VERSION.dmg`
10588

10689
## Other notes
10790

@@ -110,33 +93,6 @@ If you would like to build a (signed) netboot image there are tools for that at:
11093
If the application is started with "--repo [your own URL]" it will use a custom image repository.
11194
So can simply create another 'start menu shortcut' to the application with that parameter to use the application with your own images.
11295

113-
### Telemetry
114-
115-
In order to understand usage of the application (e.g. uptake of Raspberry Pi Imager versions and which images and operating systems are most popular) when using the default image repository, the URL, operating system name and category (if present) of a selected image are sent along with the running version of Raspberry Pi Imager, your operating system, CPU architecture, locale and Raspberry Pi revision (if applicable) to https://rpi-imager-stats.raspberrypi.com by downloadstatstelemetry.cpp.
116-
117-
This web service is hosted by [Heroku](https://www.heroku.com) and only stores an incrementing counter using a [Redis Sorted Set](https://redis.io/topics/data-types#sorted-sets) for each URL, operating system name and category per day in the `eu-west-1` region and does not associate any personal data with those counts. This allows us to query the number of downloads over time and nothing else.
118-
119-
The last 1,500 requests to the service are logged for one week before expiring as this is the [minimum log retention period for Heroku](https://devcenter.heroku.com/articles/logging#log-history-limits).
120-
121-
On Windows, you can opt out of telemetry by disabling it in the Registry:
122-
123-
```pwsh
124-
reg add "HKCU\Software\Raspberry Pi\Imager" /v telemetry /t REG_DWORD /d 0
125-
```
126-
127-
On Linux, run `rpi-imager --disable-telemetry` or add the following to `~/.config/Raspberry Pi/Imager.conf`:
128-
129-
```ini
130-
[General]
131-
telemetry=false
132-
```
133-
134-
On macOS, disable it by editing the property list for the application:
135-
136-
```sh
137-
defaults write org.raspberrypi.Imager.plist telemetry -bool NO
138-
```
139-
14096
### License
14197

14298
The main code of the Imaging Utility is made available under the terms of the Apache license.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ZFlash is available for **Windows**, **macOS**(both Intel and Apple Silicon), an
2929
1. **Choose an Operating System**:
3030
* Click on **CHOOSE OS**.
3131
* You can select from the list of available EVE-OS LTS images.
32-
* Alternatively, you can choose 'Use custom' to select a custom image file from your computer. ZFlash supports common disk image formats (e.g., `.raw`, `.img`, `.wic`) and compressed archives (e.g., `.zip`, `.gz`, `.xz`, `.zst`).
32+
* Alternatively, you can choose 'Use custom' to select a custom image file from your computer. ZFlash supports common disk image formats (e.g., `.raw`, `.img`, `.iso`, `.wic`) and compressed archives (e.g., `.zip`, `.gz`, `.xz`, `.zst`).
3333

3434
2. **Choose Storage**:
3535
* Click on **CHOOSE STORAGE**.

0 commit comments

Comments
 (0)