diff --git a/README.md b/README.md index 730fe22..c0f45b3 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ If your USB audio adapter has midi connectors, you can use midi devices (keyboar ### [Building PiPedal from Source](docs/BuildingPiPedalFromSource.md) ### [Build Prerequisites](docs/BuildPrerequisites.md) -### [The Build Systems](docs/TheBuildSystem.md) +### [The Build System](docs/TheBuildSystem.md) ### [How to Debug PiPedal](docs/Debugging.md) diff --git a/docs/AudioLatency.md b/docs/AudioLatency.md index c35fc71..4e79f5e 100644 --- a/docs/AudioLatency.md +++ b/docs/AudioLatency.md @@ -21,3 +21,6 @@ There is some reason to believe that there are outstanding issues with the Broad For the meantime, for best results, log off from your Raspberry Pi, and use the web interface only. You may also want to watch out for temperature throttling of the CPUs. PiPedal displays the current CPU temperature in the bottom-right corner of the display. The system will reduce CPU speed in order prevent damage to the system if the CPU temperature goes above 70C (perhaps above 60C). The Pi 400 already has good heat sinks, so you shouldn't run into problems when running on a Pi 400. If you run into throttling problems on a Raspberry Pi 4, you may want to buy and install a heat sink (ridiculously cheap), or install a cooling fan. As a temporary work-around, you can orient the Raspberry Pi 4 board vertically, which can provide a real and meaningful reduction in CPU temperature. + +-------- +[<< System Requirements](ChoosingAUsbAudioAdapter.md) | [Command-Line Configuration of PiPedal >>](CommandLine.md) \ No newline at end of file diff --git a/docs/BuildingPiPedalFromSource.md b/docs/BuildingPiPedalFromSource.md index 42dd673..0d2df6f 100644 --- a/docs/BuildingPiPedalFromSource.md +++ b/docs/BuildingPiPedalFromSource.md @@ -8,3 +8,6 @@ Microsoft Visual Studio Code. If you use VSCode, you will almost definitely need You should also be able to cross-compile PiPedal easily enough, but we do not currently provide support on how to do this. Visual Studio Code provides excellent support for cross-compiling, and good support for remote and cross-platform debugging, all of which should work with the PiPedal CMake build. In early development, PiPedal was built and debugged remotely on a Raspberry Pi, from a Windows desktop system. This should still more-or-less work, although you may have to scramble a bit to install some of the build dependencies. + +-------- +[<< Which LV2 Plugins Does PiPedal Support?](WhichLv2PluginsAreSupported.md) | [Build Prerequisites >>](BuildPrerequisites.md) \ No newline at end of file diff --git a/docs/ChangingTheWebServerPort.md b/docs/ChangingTheWebServerPort.md index cf404b3..c5b77c6 100644 --- a/docs/ChangingTheWebServerPort.md +++ b/docs/ChangingTheWebServerPort.md @@ -11,3 +11,6 @@ You can optionally restrict the addresses on which PiPedal will respond by provi To configure PiPedal to only accept connections on the Wi-Fi host access point: sudo pipedalconfig --install --port 172.22.1.1:80 + +-------- +[<< Command-Line Configuration of PiPedal](CommandLine.md) | [Using LV2 Audio Plugins >>](UsingLv2Plugins.md) \ No newline at end of file diff --git a/docs/ChoosingAUsbAudioAdapter.md b/docs/ChoosingAUsbAudioAdapter.md index f766b5d..b467d5b 100644 --- a/docs/ChoosingAUsbAudioAdapter.md +++ b/docs/ChoosingAUsbAudioAdapter.md @@ -8,4 +8,7 @@ Pay close attention to the input VU meter of the first effect in your guitar eff Again, the MOTU M2 excels in this regard. It provides large, volume knobs for input and output, along with very readable VU meters which indicate both input and output signal levels. +-------- +[<< Configuring PiPedal After Installation](Configuring.md) | [Optimizing Audio Latency >>](AudioLatency.md) + diff --git a/docs/CommandLine.md b/docs/CommandLine.md index 4598910..54a903d 100644 --- a/docs/CommandLine.md +++ b/docs/CommandLine.md @@ -15,4 +15,7 @@ Things you can do with pipedalconfig: - enable or disable the Wi-Fi hotspot. Run `pipedalconfig --help` for available options. + +-------- +[<< Optimizing Audio Latency](AudioLatency.md) | [Changin the Web Server Port >>](ChangingTheWebServerPort.md) diff --git a/docs/Configuring.md b/docs/Configuring.md index d9dbe43..d73ca58 100644 --- a/docs/Configuring.md +++ b/docs/Configuring.md @@ -30,3 +30,6 @@ There are a number of other useful settings in the hamburger menu/Settings dialo input onto the right channel of the USB audio inputs. So you probably want to configure PiPedal to use only the right USB audio input channel. You can choose how to bind USB audio input and output channels (stereo, left only, right only) in the settings dialog. If you are using a Audio device that has more than two channels, you will be offered a list of channels to choose from instead. + +-------- +[<< Installing PiPedal](Installing.md) | [Choosing a USB Audio Adapter >>](ChoosingAUsbAudioAdapter.md) \ No newline at end of file diff --git a/docs/Debugging.md b/docs/Debugging.md index b0ae363..a33f38d 100644 --- a/docs/Debugging.md +++ b/docs/Debugging.md @@ -110,3 +110,5 @@ Or you can avoid all of this, by configuring the debug instance to use a data fo ... } +----- +[<< The Build System](TheBuildSystem.md) \ No newline at end of file diff --git a/docs/Installing.md b/docs/Installing.md index b99f2c8..3bc762c 100644 --- a/docs/Installing.md +++ b/docs/Installing.md @@ -13,3 +13,6 @@ Install the package by running cd ~/Downloads sudo apt-get install ./pipedal_0.1.4_arm64.deb ``` + +-------- +[<< System Requirements](SystemRequirements.md) | [Configuring PiPedal after Installation >>](Configuring.md) \ No newline at end of file diff --git a/docs/SystemRequirements.md b/docs/SystemRequirements.md index 0bae172..241ed1d 100644 --- a/docs/SystemRequirements.md +++ b/docs/SystemRequirements.md @@ -12,3 +12,6 @@ PiPedal has been tested on the following Operating Systems: 64-bit operating systems are preferred, as they delivery significantly higher performance than 32-bit platforms. If you are using Raspberry Pi OS, make sure to upgrade to the latest version, because versions of the Linux kernel later than 5.10 provide important bug fixes for USB audio devices. + +-------- +[Installing PiPedal >>](Installing.md) \ No newline at end of file diff --git a/docs/TheBuildSystem.md b/docs/TheBuildSystem.md index 86b71fe..63c622b 100644 --- a/docs/TheBuildSystem.md +++ b/docs/TheBuildSystem.md @@ -21,3 +21,6 @@ the following shell scripts have been provided in the root of the project. If you are using a development environment other than Visual Studio Code, it should be fairly straightforward to figure out how to incorporate the PiPedal build procedure into your IDE workflow by using the contents of the build shell scripts as a model. + +----- +[<< Build Prerequisites](BuildPrerequisites.md) | [How to Debug PiPedal >>](Debugging.md) \ No newline at end of file diff --git a/docs/UsingLv2Plugins.md b/docs/UsingLv2Plugins.md index 8cfce30..46af663 100644 --- a/docs/UsingLv2Plugins.md +++ b/docs/UsingLv2Plugins.md @@ -25,3 +25,6 @@ packages on Raspbian, the effort is well worthwhile. The GxPlugins collection pr as well as emulations of famous distortion effect pedals that are not part of the main Guitarix distribution. - https://github.com/brummer10/GxPlugins.lv2 + +-------- +[<< Changing the Web Server Port](ChangingTheWebServerPort.md) | [Which LV2 Plugins Does PiPedal Support? >>](WhichLv2PluginsAreSupported.md) \ No newline at end of file diff --git a/docs/WhichLv2PluginsAreSupported.md b/docs/WhichLv2PluginsAreSupported.md index 155522a..13a5e4c 100644 --- a/docs/WhichLv2PluginsAreSupported.md +++ b/docs/WhichLv2PluginsAreSupported.md @@ -15,3 +15,6 @@ If you install new LV2 plugins, you will have to restart the PiPedal web service Although most LV2 plugins provide GUI interfaces, when running on a Linux desktop, the LV2 plugin standard is specifically designed to allow remote control without using the provided desktop GUI interface. And all but a tiny minority of LV2 plugins (most of them analyzers, unfortunately) support this. + +-------- +[<< Using LV2 Audio Plugins](UsingLv2Plugins.md) | [BuildingPiPedal from Source >>](BuildingPiPedalFromSource.md) \ No newline at end of file