Document dependency on GD for ePaper devices

This commit is contained in:
Marcos Del Sol Vives 2024-01-07 17:12:05 +01:00
parent e1d81f6faf
commit 572bdbf727
No known key found for this signature in database
6 changed files with 24 additions and 7 deletions

View file

@ -8,6 +8,7 @@ This project uses the changelog in accordance with [keepchangelog](http://keepac
- Added troubleshooting entry - ARM architecture error (@francis2054) - Added troubleshooting entry - ARM architecture error (@francis2054)
- Fixed `lf pyramid sim` - wrong parameter handling (@iceman1001) - Fixed `lf pyramid sim` - wrong parameter handling (@iceman1001)
- Fixed bootloader - Ignore jitters when pressing the button (@wh201906) - Fixed bootloader - Ignore jitters when pressing the button (@wh201906)
- Changed `hf waveshare` - image loading and processing is now done using [GDlib](https://github.com/libgd/libgd) (@socram8888)
## [Steamboat Willie.4.17768][2024-01-03] ## [Steamboat Willie.4.17768][2024-01-03]
- Changed `mem spiffs dump -t` - now supports downloading direct into trace buffer (@hazardousvoltage) - Changed `mem spiffs dump -t` - now supports downloading direct into trace buffer (@hazardousvoltage)

View file

@ -72,6 +72,9 @@ you can skip the installation of `qtbase5-dev`.
👉 If you don't need support for Python3 scripts in the Proxmark3 client, 👉 If you don't need support for Python3 scripts in the Proxmark3 client,
you can skip the installation of `libpython3-dev`. you can skip the installation of `libpython3-dev`.
👉 If you don't need support for NFC ePaper devices,
you can skip the installation of `libgd-dev`.
### Failed to load module... ### Failed to load module...
⚠️ If you get some (non blocking) error at runtime such as _Gtk-Message: Failed to load module "canberra-gtk-module"_ ⚠️ If you get some (non blocking) error at runtime such as _Gtk-Message: Failed to load module "canberra-gtk-module"_
you may have to install `libcanberra-gtk-module`. you may have to install `libcanberra-gtk-module`.
@ -82,7 +85,7 @@ you may have to install `libcanberra-gtk-module`.
```sh ```sh
sudo pacman -Syu git base-devel readline bzip2 lz4 arm-none-eabi-gcc \ sudo pacman -Syu git base-devel readline bzip2 lz4 arm-none-eabi-gcc \
arm-none-eabi-newlib qt5-base bluez python --needed arm-none-eabi-newlib qt5-base bluez python gd --needed
``` ```
### If you don't need... ### If you don't need...
@ -95,6 +98,9 @@ you can skip the installation of `qt5-base`.
👉 If you don't need support for Python3 scripts in the Proxmark3 client, 👉 If you don't need support for Python3 scripts in the Proxmark3 client,
you can skip the installation of `python`. you can skip the installation of `python`.
👉 If you don't need support for NFC ePaper devices,
you can skip the installation of `gd`.
## On Fedora ## On Fedora
^[Top](#top) ^[Top](#top)
@ -102,7 +108,7 @@ you can skip the installation of `python`.
```sh ```sh
sudo dnf install git make gcc gcc-c++ arm-none-eabi-gcc-cs arm-none-eabi-newlib \ sudo dnf install git make gcc gcc-c++ arm-none-eabi-gcc-cs arm-none-eabi-newlib \
readline-devel bzip2-devel lz4-devel qt5-qtbase-devel bluez-libs-devel \ readline-devel bzip2-devel lz4-devel qt5-qtbase-devel bluez-libs-devel \
python3-devel libatomic openssl-devel python3-devel libatomic openssl-devel gd-devel
``` ```
### If you don't need... ### If you don't need...
@ -115,6 +121,9 @@ you can skip the installation of `qt5-qtbase-devel`.
👉 If you don't need support for Python3 scripts in the Proxmark3 client, 👉 If you don't need support for Python3 scripts in the Proxmark3 client,
you can skip the installation of `python3-devel`. you can skip the installation of `python3-devel`.
👉 If you don't need support for NFC ePaper devices,
you can skip the installation of `gd-devel`.
## On openSUSE ## On openSUSE
^[Top](#top) ^[Top](#top)
@ -122,7 +131,8 @@ you can skip the installation of `python3-devel`.
```sh ```sh
sudo zypper install git patterns-devel-base-devel_basis gcc-c++ \ sudo zypper install git patterns-devel-base-devel_basis gcc-c++ \
readline-devel libbz2-devel liblz4-devel cross-arm-none-gcc9 \ readline-devel libbz2-devel liblz4-devel cross-arm-none-gcc9 \
cross-arm-none-newlib-devel python3-devel libqt5-qtbase-devel libopenssl-devel cross-arm-none-newlib-devel python3-devel libqt5-qtbase-devel \
libopenssl-devel gd-devel
``` ```
Note that Bluez is not available on openSUSE so the native Bluetooth support won't be available in the client. Note that Bluez is not available on openSUSE so the native Bluetooth support won't be available in the client.
@ -134,6 +144,9 @@ you can skip the installation of `libqt5-qtbase-devel`.
👉 If you don't need support for Python3 scripts in the Proxmark3 client, 👉 If you don't need support for Python3 scripts in the Proxmark3 client,
you can skip the installation of `python3-devel`. you can skip the installation of `python3-devel`.
👉 If you don't need support for NFC ePaper devices,
you can skip the installation of `gd-devel`.
# Clone the repository # Clone the repository
^[Top](#top) ^[Top](#top)

View file

@ -169,11 +169,12 @@ Install dependencies:
```sh ```sh
sudo apt-get install --no-install-recommends git ca-certificates build-essential pkg-config \ sudo apt-get install --no-install-recommends git ca-certificates build-essential pkg-config \
libreadline-dev gcc-arm-none-eabi libnewlib-dev \ libreadline-dev gcc-arm-none-eabi libnewlib-dev \
libbz2-dev liblz4-dev libpython3-dev qtbase5-dev libssl-dev libbz2-dev liblz4-dev libpython3-dev qtbase5-dev libssl-dev libgd-dev
``` ```
_note_ _note_
If you don't need the graphical components of the Proxmark3 client, you can skip the installation of `qtbase5-dev`. If you don't need the graphical components of the Proxmark3 client, you can skip the installation of `qtbase5-dev`.
If you don't need support for Python3 scripts in the Proxmark3 client, you can skip the installation of `libpython3-dev`. If you don't need support for Python3 scripts in the Proxmark3 client, you can skip the installation of `libpython3-dev`.
If you don't need support for NFC ePaper devices, you can skip the installation of `libgd-dev`.
## Clone the Iceman repository ## Clone the Iceman repository
^[Top](#top) ^[Top](#top)

View file

@ -108,12 +108,14 @@ then, install proxmark dependencies:
sudo apt-get install --no-install-recommends \ sudo apt-get install --no-install-recommends \
git ca-certificates build-essential pkg-config \ git ca-certificates build-essential pkg-config \
libreadline-dev gcc-arm-none-eabi libnewlib-dev \ libreadline-dev gcc-arm-none-eabi libnewlib-dev \
libbz2-dev liblz4-dev libpython3-dev qtbase5-dev libssl-dev libbz2-dev liblz4-dev libpython3-dev qtbase5-dev \
libssl-dev libgd-dev
``` ```
_note_ _note_
If you don't need the graphical components of the Proxmark3 client, you can skip the installation of `qtbase5-dev`. If you don't need the graphical components of the Proxmark3 client, you can skip the installation of `qtbase5-dev`.
If you don't need support for Python3 scripts in the Proxmark3 client, you can skip the installation of `libpython3-dev`. If you don't need support for Python3 scripts in the Proxmark3 client, you can skip the installation of `libpython3-dev`.
If you don't need support for NFC ePaper devices, you can skip the installation of `libgd-dev`.
## X Server Installation ## X Server Installation
^[Top](#top) ^[Top](#top)

View file

@ -161,7 +161,7 @@ These instructions will show how to setup the environment on OSX to the point wh
2. Install dependencies: 2. Install dependencies:
``` ```
brew install readline qt5 pkgconfig coreutils brew install readline qt5 gd pkgconfig coreutils
brew install RfidResearchGroup/proxmark3/arm-none-eabi-gcc brew install RfidResearchGroup/proxmark3/arm-none-eabi-gcc
``` ```
3. (optional) Install makefile dependencies: 3. (optional) Install makefile dependencies:

View file

@ -61,7 +61,7 @@ These instructions will show how to setup the environment on OSX to the point wh
2. Install dependencies: 2. Install dependencies:
```bash ```bash
sudo port install readline jansson lua52 python311 bzip2 lz4 openssl11 arm-none-eabi-gcc arm-none-eabi-binutils coreutils qt5 qt5-qtbase pkgconfig sudo port install readline jansson lua52 python311 bzip2 lz4 openssl11 arm-none-eabi-gcc arm-none-eabi-binutils coreutils qt5 qt5-qtbase gd2 pkgconfig
``` ```
3. Clamp Python version for pkg-config 3. Clamp Python version for pkg-config