### Build Prerequisites

Run the following commands to install build tools required by the PiPedal build.

    # install CMake
    sudo apt update
    sudo apt upgrade
    sudo apt install -y cmake ninja-build build-essential g++ git

The PiPedal build process also requires version 22 or later of `node.js`. Type `node --version` to see if you have a version 
of `node.js` installed already. Otherwise run the following commands as root to install a current version of version of `node.js`: 

    sudo apt install nodejs npm curl


If your distribution doesn't provide a suitable version of nodejs, 
please refer to the `node.js` website for instructions on [how to install the latest version of `node.js`](https://nodejs.org/en/download) directly.

Run the following commands to install dependent libraries required by the PiPedal build.

Ubuntu:
    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 libbz2-dev libssl-dev librsvg2-dev

Arch Linux (alpha status):

    sudo pacman -S --needed lilv boost systemd catch2 alsa-lib \
        util-linux avahi networkmanager icu libzip gperftools \
        pipewire bzip2 openssl librsvg sdbus-cpp

    There is one AUR package:
    sudo paru -S authbind

Note: in the Arch Linux build, copyright notices generation won't work, so it needs to be disabled with a cmake argument. Add this to your .vscode/settings.json file:

```json
{
    "cmake.configureSettings": {                                                                                                                                                                                                        
        "PIPEDAL_DISABLE_COPYRIGHT_BUILD": "ON"                                                                                                                                                                                                  
    },
    ...
}
```
    

### Installing Sources

If you are using Visual Studio Code, install the following Extensions:

- C/C++ Extension Pack (Microsoft).
- CMake Tools (Microsoft)

Clone the `rerdavies/pipedal` package from github. Use the source control tools from Visual Studio Code, or

    cd ~/src    # or wherever you keep your source repositories.
    git clone https://github.com/rerdavies/pipedal.git

In the project root, run the following commands to initialize and update PiPedal submodules. These steps
must be performed even if you used Visual Studio Code to initially install the project.

    cd ~/src/pipedal
    git submodule update --init --recursive
   
Run the following command to install and configure React dependencies.

    cd ~/src/pipedal
    ./react-config   # Configure React NPM dependencies.

If you are using node.js v24 or later, you may have to run the following command:

   cd ~/src/pipedal/vite
   npm approve-scripts esbuild

PiPedal will be migrated from `esbuild` to `transformWithOxc` sometime soon. You can ignore the warning about use of `esbuild`.

And one final step. Edit the file `/etc/sysctl.conf`, and add or increase the value for the maximum number of watchable user 
files:

    fs.inotify.max_user_watches=524288

Then run `sudo sysctl -p` to get the change to take effect. Visual Studio Code and the React Debug server both need this 
setting to run properly. Older versions of Raspberry Pi OS set this value too low; and I am not honestly sure whether current 
versions of Raspberry Pi OS have fixed the problem.
   
--------------------------   
[<< Building PiPedal from Source](BuildingPiPedalFromSource.md) | [Up](Documentation.md) | [The Build System >>](TheBuildSystem.md)