Fix spelling (#998)

* minor readme updates
* add cspell config and fix spelling errors
* add CI job to check spelling

.github/workflows/doxygen.yml

@@ -36,6 +36,16 @@ on:
   workflow_dispatch:
 
 jobs:
+  check-spelling:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - uses: actions/checkout@v4
+      - name: Install cSpell
+        run: npm install -g cspell
+      - run: npx cspell --gitignore --config cspell.config.yaml .
   build-docs:
     uses: nRF24/.github/.github/workflows/build_docs.yaml@main
     with:

CMakeLists.txt

@@ -72,12 +72,12 @@ endif()
 include(${CMAKE_CURRENT_LIST_DIR}/cmake/detectCPU.cmake) # sets the variable SOC accordingly
 
 # auto-detect what driver to use
-# auto-detect can be overriden using `cmake .. -D RF24_DRIVER=<supported driver>`
+# auto-detect can be overridden using `cmake .. -D RF24_DRIVER=<supported driver>`
 include(${CMAKE_CURRENT_LIST_DIR}/cmake/AutoConfig_RF24_DRIVER.cmake)
 
 #[[ adding the utility sub-directory will
     1. set variables RF24_DRIVER, RF24_LINKED_DRIVER, and RF24_DRIVER_SOURCES
-    2. copy the approriate /utility/*/includes.h file to the /utility folder
+    2. copy the appropriate /utility/*/includes.h file to the /utility folder
     3. set additional install rules according to the RF24_DRIVER specified
 ]]
 add_subdirectory(utility)

CONTRIBUTING.md

@@ -4,11 +4,11 @@ These are the current requirements for getting your code included in RF24:
 
 - Try your best to follow the rest of the code, if you're unsure then [the NASA C style guide](https://ntrs.nasa.gov/archive/nasa/casi.ntrs.nasa.gov/19950022400.pdf) can help as it's closest to the current style.
 
-- Definetly follow [PEP-8](https://www.python.org/dev/peps/pep-0008/) if it's Python code.
+- Definitely follow [PEP-8](https://www.python.org/dev/peps/pep-0008/) if it's Python code.
 
 - Follow the [Arduino example formatting style](https://docs.arduino.cc/learn/contributions/arduino-writing-style-guide) for Arduino examples
 
-- Add [doxygen-compatible documentation](https://www.doxygen.nl/manual/docblocks.html) to any new functions you add, or update existing documentation if you change behaviour
+- Add [doxygen-compatible documentation](https://www.doxygen.nl/manual/docblocks.html) to any new functions you add, or update existing documentation if you change behavior
 
 - CMake modules and CMakeLists.txt files should also have a uniform syntax.
   - Indentation is a mandatory 4 spaces (not a `\t` character).

LICENSE

@@ -291,7 +291,7 @@ convey the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     {description}
-    Copyright (C) {year}  {fullname}
+    Copyright (C) {year}  {full name}
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -312,22 +312,22 @@ Also add information on how to contact you by electronic and paper mail.
 If the program is interactive, make it output a short notice like this
 when it starts in an interactive mode:
 
-    Gnomovision version 69, Copyright (C) year name of author
-    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    SomeProgram version 69, Copyright (C) year name of author
+    SomeProgram comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
 
-The hypothetical commands `show w' and `show c' should show the appropriate
+The hypothetical commands `show w` and `show c` should show the appropriate
 parts of the General Public License.  Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
+be called something other than `show w` and `show c`; they could even be
 mouse-clicks or menu items--whatever suits your program.
 
 You should also get your employer (if you work as a programmer) or your
 school, if any, to sign a "copyright disclaimer" for the program, if
 necessary.  Here is a sample; alter the names:
 
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
-  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+  SomeCompany, Inc., hereby disclaims all copyright interest in the program
+  'SomeProgram' (which makes passes at compilers) written by James Hacker.
 
   {signature of Ty Coon}, 1 April 1989
   Ty Coon, President of Vice

RF24.h

@@ -1746,7 +1746,7 @@ class RF24
      *
      * On all devices but Linux and ATTiny, a small delay is added to the CSN toggling function
      *
-     * This is intended to minimise the speed of SPI polling due to radio commands
+     * This is intended to minimize the speed of SPI polling due to radio commands
      *
      * If using interrupts or timed requests, this can be set to 0 Default:5
      */
@@ -1789,7 +1789,7 @@ class RF24
      * @brief Open or close all data pipes.
      *
      * This function does not alter the addresses assigned to pipes. It is simply a
-     * convenience function that allows controling all pipes at once.
+     * convenience function that allows controlling all pipes at once.
      * @param isEnabled `true` opens all pipes; `false` closes all pipes.
      */
     void toggleAllPipes(bool isEnabled);

cmake/PreventInSourceBuilds.cmake

@@ -2,11 +2,11 @@
 # This function will prevent in-source builds
 function(AssureOutOfSourceBuilds)
     # make sure the user doesn't play dirty with symlinks
-    get_filename_component(srcdir "${CMAKE_SOURCE_DIR}" REALPATH)
-    get_filename_component(bindir "${CMAKE_BINARY_DIR}" REALPATH)
+    get_filename_component(src_dir "${CMAKE_SOURCE_DIR}" REALPATH)
+    get_filename_component(bin_dir "${CMAKE_BINARY_DIR}" REALPATH)
 
     # disallow in-source builds
-    if("${srcdir}" STREQUAL "${bindir}")
+    if("${src_dir}" STREQUAL "${bin_dir}")
         message("######################################################")
         message("Warning: in-source builds are disabled")
         message("Please create a separate build directory and run cmake from there")
@@ -15,4 +15,4 @@ function(AssureOutOfSourceBuilds)
     endif()
 endfunction()
 
-assureoutofsourcebuilds()
+AssureOutOfSourceBuilds()

cmake/detectCPU.cmake

@@ -58,7 +58,7 @@ endif()
 
 message(STATUS "tool name being used: ${tool_name}")
 
-# add compiler flags to optomize builds with arm-linux-gnueabihf-g* compilers
+# add compiler flags to optimize builds with arm-linux-gnueabihf-g* compilers
 if("${tool_name}" STREQUAL "arm-linux-gnueabihf")
     if("${SOC}" STREQUAL "BCM2835" OR "${SOC}" STREQUAL "BCM2708")
         add_compile_options(-marm -march=armv6zk -mtune=arm1176jzf-s -mfpu=vfp -mfloat-abi=hard)

cmake/toolchains/arm64.cmake

@@ -16,8 +16,8 @@ set(CMAKE_CXX_COMPILER /usr/bin/aarch64-linux-gnu-g++)
 # add_compile_options(-I /usr/aarch64-linux-gnu/include) # this may not be best practice
 
 #[[
-# CMAKE_STAGING_PREFIX is only useful for transfering a built CMake project to a target machine
-set(CMAKE_STAGING_PREFIX /home/devel/stage) # use CMAKE_INSTALL_PREFIX instead (see below comments)
+# CMAKE_STAGING_PREFIX is only useful for transferring a built CMake project to a target machine
+set(CMAKE_STAGING_PREFIX /home/dev/stage) # use CMAKE_INSTALL_PREFIX instead (see below comments)
 
 CMAKE_FIND_ROOT_PATH is an empty list by default (this list can be modified where applicable)
 if cross-compiling a dependent lib (like MRAA - which is optional), then

cmake/toolchains/armhf.cmake

@@ -16,8 +16,8 @@ set(CMAKE_CXX_COMPILER /usr/bin/arm-linux-gnueabihf-g++)
 # add_compile_options(-I /usr/arm-linux-gnueabihf/include) # this may not be best practice
 
 #[[
-# CMAKE_STAGING_PREFIX is only useful for transfering a built CMake project to a target machine
-set(CMAKE_STAGING_PREFIX /home/devel/stage) # use CMAKE_INSTALL_PREFIX instead (see below comments)
+# CMAKE_STAGING_PREFIX is only useful for transferring a built CMake project to a target machine
+set(CMAKE_STAGING_PREFIX /home/dev/stage) # use CMAKE_INSTALL_PREFIX instead (see below comments)
 
 CMAKE_FIND_ROOT_PATH is an empty list by default (this list can be modified where applicable)
 if cross-compiling a dependent lib (like MRAA - which is optional), then

cmake/toolchains/i686.cmake

@@ -16,8 +16,8 @@ set(CMAKE_CXX_COMPILER /usr/bin/i686-linux-gnu-g++)
 # add_compile_options(-I /usr/i686-linux-gnu/include) # this may not be best practice
 
 #[[
-# CMAKE_STAGING_PREFIX is only useful for transfering a built CMake project to a target machine
-set(CMAKE_STAGING_PREFIX /home/devel/stage) # use CMAKE_INSTALL_PREFIX instead (see below comments)
+# CMAKE_STAGING_PREFIX is only useful for transferring a built CMake project to a target machine
+set(CMAKE_STAGING_PREFIX /home/dev/stage) # use CMAKE_INSTALL_PREFIX instead (see below comments)
 
 CMAKE_FIND_ROOT_PATH is an empty list by default (this list can be modified where applicable)
 if cross-compiling a dependent lib (like MRAA - which is optional), then

cmake/toolchains/x86_64.cmake

@@ -16,8 +16,8 @@ set(CMAKE_CXX_COMPILER /usr/bin/x86_64-linux-gnux32-g++)
 # add_compile_options(-I /usr/x86_64-linux-gnux32/include) # this may not be best practice
 
 #[[
-# CMAKE_STAGING_PREFIX is only useful for transfering a built CMake project to a target machine
-set(CMAKE_STAGING_PREFIX /home/devel/stage) # use CMAKE_INSTALL_PREFIX instead (see below comments)
+# CMAKE_STAGING_PREFIX is only useful for transferring a built CMake project to a target machine
+set(CMAKE_STAGING_PREFIX /home/dev/stage) # use CMAKE_INSTALL_PREFIX instead (see below comments)
 
 CMAKE_FIND_ROOT_PATH is an empty list by default (this list can be modified where applicable)
 if cross-compiling a dependent lib (like MRAA - which is optional), then