Update docs

Co-authored-by: s-martin <[email protected]>

Author: AlvinSchiller

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
 

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

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'
 

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.
 

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