From 2d4b5b8b28f88ab599161def295c7b0b6e440920 Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Sun, 5 Jan 2025 14:29:40 +0100 Subject: [PATCH] Update docs Co-authored-by: s-martin --- CONTRIBUTING.md | 2 +- components/rfid-reader/RC522/requirements.txt | 2 +- packages-excluded.txt | 2 +- requirements-excluded.txt | 2 +- scripts/installscripts/install-jukebox.sh | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc1956863..e443a526f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,7 +94,7 @@ If the code change results in a test failure, we will make our best effort to co * All code has to run under the stable and legacy version of Raspberry Pi OS (please check if currently even an older version is still supported). * For GPIO all code should work with **RPi.GPIO**. gpiozero is currently not intended to use. > [!IMPORTANT] - > The original `RPi.GPIO` packages is currently not compatible with the 6.6 kernel (since bookworm). Therefore the lib `rpi-lgpio` is used as a replacement, which is api compliant. `RPi.GPIO` must not be installed directly or as a dependency as this breaks GPIO functionality (see `requirements-excluded`)! + > The original `RPi.GPIO` package is currently not compatible with the 6.6 kernel (since bookworm). Therefore the lib `rpi-lgpio` is used as a replacement, which is api compliant. `RPi.GPIO` **must not** be installed directly or as a dependency as this breaks GPIO functionality (see `requirements-excluded`)! ### Additional Resources diff --git a/components/rfid-reader/RC522/requirements.txt b/components/rfid-reader/RC522/requirements.txt index ebec34374..b2f7aa89f 100644 --- a/components/rfid-reader/RC522/requirements.txt +++ b/components/rfid-reader/RC522/requirements.txt @@ -1,7 +1,7 @@ # RC522 related requirements # You need to install these with `sudo python3 -m pip install --upgrade --force-reinstall --no-deps -q -r requirements.txt` -#pi-rc522 has RPi.GPIO as a dependecy which is broken since kernel 6.6. +#pi-rc522 has RPi.GPIO as a dependency which is broken since kernel 6.6. #Skip dependencies whith --no-deps and use the rpi-lgpio lib as a replacement, which should already be installed from the main installation. spidev # dep of pi-rc522 diff --git a/packages-excluded.txt b/packages-excluded.txt index 1618cb99a..31daa451d 100644 --- a/packages-excluded.txt +++ b/packages-excluded.txt @@ -1,4 +1,4 @@ -# Remove exluded libs, if installed - see https://github.com/MiczFlor/RPi-Jukebox-RFID/pull/2469 +# Remove excluded libs, if installed - see https://github.com/MiczFlor/RPi-Jukebox-RFID/pull/2469 # Define packages for apt-get. These must be removed with # 'sed 's/#.*//g' packages.txt | xargs sudo apt-get remove' diff --git a/requirements-excluded.txt b/requirements-excluded.txt index 96d214372..5d407f43c 100644 --- a/requirements-excluded.txt +++ b/requirements-excluded.txt @@ -1,4 +1,4 @@ -# Remove exluded libs, if installed - see https://github.com/MiczFlor/RPi-Jukebox-RFID/pull/2469 +# Remove excluded libs, if installed - see https://github.com/MiczFlor/RPi-Jukebox-RFID/pull/2469 # Libraries which must be excluded. These must be removed with # `sudo python3 -m pip uninstall -y -r requirements-excluded.txt` before you can run this. diff --git a/scripts/installscripts/install-jukebox.sh b/scripts/installscripts/install-jukebox.sh index 47343cb33..801d5ef15 100644 --- a/scripts/installscripts/install-jukebox.sh +++ b/scripts/installscripts/install-jukebox.sh @@ -919,7 +919,7 @@ install_main() { source "${jukebox_dir}"/scripts/helperscripts/inc.helper.sh source "${jukebox_dir}"/scripts/helperscripts/inc.networkHelper.sh - # Remove exluded libs, if installed - see https://github.com/MiczFlor/RPi-Jukebox-RFID/pull/2469 + # Remove excluded libs, if installed - see https://github.com/MiczFlor/RPi-Jukebox-RFID/pull/2469 call_with_args_from_file "${jukebox_dir}"/packages-excluded.txt ${apt_get} ${allow_downgrades} remove # some packages are only available on raspberry pi's but not on test docker containers running on x86_64 machines @@ -954,7 +954,7 @@ install_main() { echo "${VERSION_NO} - ${COMMIT_NO} - ${USED_BRANCH}" > ${jukebox_dir}/settings/version chmod 777 ${jukebox_dir}/settings/version - # Remove exluded libs, if installed - see https://github.com/MiczFlor/RPi-Jukebox-RFID/pull/2469 + # Remove excluded libs, if installed - see https://github.com/MiczFlor/RPi-Jukebox-RFID/pull/2469 ${pip_uninstall} -r "${jukebox_dir}"/requirements-excluded.txt # Install required spotify packages