Housekeeping - documentation update.

Introduced a new dependency checking script that validates required apt packages before building the project

Documented the expanded package list and instructions for running the script within the build prerequisites documentation

Updated build system instructions to call the dependency checker prior to configuring with CMake
This commit is contained in:
Extremesecrecy
2025-07-24 08:20:24 -07:00
parent 1e9cd5eb13
commit 12ecf3c209
4 changed files with 60 additions and 6 deletions
+17 -3
View File
@@ -57,20 +57,34 @@ https://github.com/user-attachments/assets/9a9fd0c6-78fc-4284-8b44-6a1929c00cc6
### [Command-Line Configuration of PiPedal](https://rerdavies.github.io/pipedal/CommandLine.html)
### [Changing the Web Server Port](https://rerdavies.github.io/pipedal/ChangingTheWebServerPort.html)
%nbsp;
 
### [Using LV2 Audio Plugins](https://rerdavies.github.io/pipedal/UsingLv2Plugins.md)
### [Which LV2 Plugins does PiPedal support?](https://rerdavies.github.io/pipedal/WhichLv2PluginsAreSupported.html)
### [Support for LV2 Plugins with MOD User Interfaces](https://rerdavies.github.io/pipedal/ModUiSupport.html)
  
 
### [Building PiPedal from Source](https://rerdavies.github.io/pipedal/BuildingPiPedalFromSource.html)
### [Build Prerequisites](https://rerdavies.github.io/pipedal/BuildPrerequisites.html)
### [The Build System](https://rerdavies.github.io/pipedal/TheBuildSystem.html)
### Setup
Fetch the project's submodules before building:
```sh
git submodule update --init --recursive
```
After running this command the following directories should be populated:
- `modules/SQLiteCpp`
- `modules/websocketpp`
- `submodules/pipedal_p2pd`
### [How to Debug PiPedal](https://rerdavies.github.io/pipedal/Debugging.html)
 
 
#### [PiPedal Architecture](https://rerdavies.github.io/pipedal/Architecture.html)
+10 -2
View File
@@ -21,13 +21,21 @@ Run the following commands to install dependent libraries required by the PiPeda
sudo apt update
sudo apt upgrade
sudo apt install -y liblilv-dev libboost-dev \
libsystemd-dev catch libasound2-dev uuid-dev \
authbind libavahi-client-dev libnm-dev libicu-dev \
libsdbus-c++-dev libzip-dev google-perftools \
libgoogle-perftools-dev \
libpipewire-0.3-dev
libpipewire-0.3-dev libwebsocketpp-dev libsdl2-dev
After installing these packages, run the dependency checker to verify that
everything required is present:
```bash
cd ~/src/pipedal
./scripts/check_deps.sh
```
### Installing Sources
+3 -1
View File
@@ -13,7 +13,9 @@ available through the Code plugins store) has configured itself, build commands
If you are not using Visual Studio Code, you can configure, build and install PiPedal using CMake build tools. For your convenience,
the following shell scripts have been provided in the root of the project.
./init.sh # Configure the CMake build for the first time, or if you
./scripts/check_deps.sh # Verify required system packages
./init.sh # Configure the CMake build for the first time, or if you
# have changed one of the CMakeList.txt files. (release build)
./mk.sh # Build all targets (release build)
+30
View File
@@ -0,0 +1,30 @@
#!/usr/bin/env bash
# Check for required system packages for building PiPedal.
set -e
packages=(\
liblilv-dev libboost-dev libsystemd-dev catch libasound2-dev uuid-dev \
authbind libavahi-client-dev libnm-dev libicu-dev \
libsdbus-c++-dev libzip-dev google-perftools \
libgoogle-perftools-dev libpipewire-0.3-dev \
libwebsocketpp-dev libsdl2-dev
)
missing=()
for pkg in "${packages[@]}"; do
if ! dpkg -s "$pkg" >/dev/null 2>&1; then
missing+=("$pkg")
fi
done
if [ ${#missing[@]} -ne 0 ]; then
echo "Missing packages:" >&2
for pkg in "${missing[@]}"; do
echo " $pkg" >&2
done
exit 1
else
echo "All required packages are installed." >&2
fi