Documentation: configuring PiPedal for Ubuntu.

CMakeLists.txt

@@ -7,7 +7,7 @@ project(pipedal
 
 EXECUTE_PROCESS( COMMAND dpkg --print-architecture COMMAND tr -d '\n' OUTPUT_VARIABLE DEBIAN_ARCHITECTURE )
 
-set (DISPLAY_VERSION "PiPedal v1.4.70-Release")
+set (DISPLAY_VERSION "PiPedal v1.4.70-Beta")
 set (PACKAGE_ARCHITECTURE ${DEBIAN_ARCHITECTURE})
 set (CMAKE_INSTALL_PREFIX "/usr/")
 

README.md

@@ -15,7 +15,7 @@ Documentation: [https://rerdavies.github.io/pipedal/Documentation.html](htt
 #### Important notice: PiPedal has a submitted a request to support sharing of Pipedal presets at [PatchStorage.com](https:///patchstorage.com). We need your support! Please vote for PiPedal [here](https://patchstorage.com/requests/pipedal/).
 
 
-#### NEW version 1.4.70 Release, providing [snapshots](https://rerdavies.github.io/pipedal/Snaphots.html), and a new Performance View. See the [release notes](https://rerdavies.github.io/pipedal/ReleaseNotes) for details.
+#### NEW version 1.4.70 Beta. See the [release notes](https://rerdavies.github.io/pipedal/ReleaseNotes) for details.
 
  
 

docs/Configuring.md

@@ -3,6 +3,22 @@ page_icon: img/Setup.jpg
 icon_width: 320px
 icon_float: left
 ---
+## Selecting a real-time kernel on Ubuntu. 
+
+This step is unneccesary on Raspberry Pi OS, which installs an RT_PREEMPT kernel by default.
+
+By default, Ubuntu installs a PREEMT_DYNAMIC kernel, configured to run with volutary preemption. You will need to change this. You can do this by running the following command after you have installed PiPedal:
+
+```
+   pipedal_kconfig
+```
+
+In order to support real-time audio processing, select Preempt=full. 
+
+An RT_PREEMPT kernel provides slightly better realtime audio than a PREEMPT_DYNAMIC/preempt=full kernel, but the PREEMPT_DYNAMIC should be perfectly adequate. If you are having problems with audio dropouts, you may want to try an RT_PREEMPT kernel instead. Ubuntu provides a pre-built RT_PREEMPT kernel; but on our test systems, you can acheive stable low-latency audio using only the PREEMPT_DYNAMIC/preempt=full kernel. The pre-build Ubuntu RT_PREEMPT 
+kernel is only available if yo have an Ubuntu Pro subscription. But it is relatively easy to build the Ubuntu RT_PREEMPT kernel from source. That is, however, outside the scope of this document. We recommend using the PREEMPT_DYNAMIC/preempt=full Ubuntu kernel. 
+
+
 ## Configuring PiPedal After Installation
 
 

docs/Installing.md

@@ -13,24 +13,25 @@ page_icon: img/Install4.jpg
 
 Download the most recent Debian (.deb) package for your platform:
 
-- [Raspberry Pi OS bookworm (64-bit) v1.4.70](https://github.com/rerdavies/pipedal/releases/download/)
-- [Ubuntu/Raspberry Pi OS bullseyeye (64-bit) v1.2.31](https://github.com/rerdavies/pipedal/releases/download/v1.1.31/pipedal_1.1.31_arm64.deb)
+- [Raspberry Pi OS bookworm (aarch64) v1.4.70 Beta](https://github.com/rerdavies/pipedal/releases/download/)
+- [Ubuntu 24.x (aarch64) v1.4.70 Alpha](https://github.com/rerdavies/pipedal/releases/download/)
+- [Ubuntu 24.x (amd64) v1.4.70 Alpha](https://github.com/rerdavies/pipedal/releases/download/)
 
-Version 1.4.70 has not yet been tested on Ubuntu or Raspberry Pi OS bullseye. On these platforms, we recommend that you use version 1.1.31.
 
-Install the package by running 
+Version 1.4.70 has been tested on Raspberry Pi OS bookworm, Ubuntu 24.04 (amd64), and Ubuntu 24.10 (aarch64). Download the appropriate package for your platform, and install using the following proceduer:
 
 ```
   sudo apt update
   cd ~/Downloads  
   sudo apt-get install pipedal_1.4.70_arm64.deb 
 ```
-Adjust accordingly if you have downloaded v1.1.31.
+Adjust accordingly depending which package you downloaded.
 
 On Raspberry Pi OS, if you have a graphical desktop installed, you can also install the package by double-clicking on the downloaded package in the File Manager.
 
 
-After installing, follow the instructions in [Configuring PiPedal after Installation](Configuring.md).
+After installing, follow the instructions in [Configuring PiPedal after Installation](Configuring.md). If 
+you are using Ubuntu, you will need to reconfigure Ubuntu to use a real-time kernel. 
 
 
 --------

docs/index.md

@@ -10,7 +10,8 @@ To view PiPedal documentation, click [here](Documentation.md).
 be enormously grateful. Note that media and model files are included in patch files, so you can share patches that 
 include model files or audio samples. If you make use of plugins that are not included in the PiPedal distribution, please include a link to the plugin in the patch description.
 
-#### NEW version 1.4.70 Release. See the [release notes](https://rerdavies.github.io/pipedal/ReleaseNotes) for details.
+#### NEW version 1.4.70 Beta, plus alpha releases of 
+PiPedal for Ubuntu on aarch64 and amd64. See the [release notes](https://rerdavies.github.io/pipedal/ReleaseNotes) for details.