From e838c1f0d65e18372ccbb1d954177db8721b9dc1 Mon Sep 17 00:00:00 2001 From: Robin Davies Date: Sat, 12 Mar 2022 13:42:48 -0500 Subject: [PATCH] Improve documentatin navigation. --- docs/AudioLatency.md | 2 +- docs/BuildPrerequisites.md | 2 +- docs/BuildingPiPedalFromSource.md | 2 +- docs/ChangingTheWebServerPort.md | 2 +- docs/ChoosingAUsbAudioAdapter.md | 2 +- docs/CommandLine.md | 2 +- docs/Configuring.md | 2 +- docs/Debugging.md | 2 +- docs/Installing.md | 2 +- docs/SystemRequirements.md | 2 +- docs/TheBuildSystem.md | 2 +- docs/UsingLv2Plugins.md | 2 +- docs/WhichLv2PluginsAreSupported.md | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/AudioLatency.md b/docs/AudioLatency.md index 4e79f5e..837e10e 100644 --- a/docs/AudioLatency.md +++ b/docs/AudioLatency.md @@ -23,4 +23,4 @@ For the meantime, for best results, log off from your Raspberry Pi, and use the 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 +[<< System Requirements](ChoosingAUsbAudioAdapter.md) | [Up](Documentation.md) | [Command-Line Configuration of PiPedal >>](CommandLine.md) \ No newline at end of file diff --git a/docs/BuildPrerequisites.md b/docs/BuildPrerequisites.md index 6d9146f..198ed07 100644 --- a/docs/BuildPrerequisites.md +++ b/docs/BuildPrerequisites.md @@ -42,5 +42,5 @@ Run the following command to install and configure React dependencies. ./react-config # Configure React NPM dependencies. -------------------------- -[<< Building PiPedal from Source](BuildingPiPedalFromSource.md) | [The Build System >>](TheBuildSystem.md) +[<< Building PiPedal from Source](BuildingPiPedalFromSource.md) | [Up](Documentation.md) | [The Build System >>](TheBuildSystem.md) diff --git a/docs/BuildingPiPedalFromSource.md b/docs/BuildingPiPedalFromSource.md index 0d2df6f..dc1fd6e 100644 --- a/docs/BuildingPiPedalFromSource.md +++ b/docs/BuildingPiPedalFromSource.md @@ -10,4 +10,4 @@ and cross-platform debugging, all of which should work with the PiPedal CMake bu 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 +[<< Which LV2 Plugins Does PiPedal Support?](WhichLv2PluginsAreSupported.md) | [Up](Documentation.md) | [Build Prerequisites >>](BuildPrerequisites.md) \ No newline at end of file diff --git a/docs/ChangingTheWebServerPort.md b/docs/ChangingTheWebServerPort.md index c5b77c6..53970e3 100644 --- a/docs/ChangingTheWebServerPort.md +++ b/docs/ChangingTheWebServerPort.md @@ -13,4 +13,4 @@ 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 +[<< Command-Line Configuration of PiPedal](CommandLine.md) | [Up](Documentation.md) | [Using LV2 Audio Plugins >>](UsingLv2Plugins.md) \ No newline at end of file diff --git a/docs/ChoosingAUsbAudioAdapter.md b/docs/ChoosingAUsbAudioAdapter.md index b467d5b..1c7f91c 100644 --- a/docs/ChoosingAUsbAudioAdapter.md +++ b/docs/ChoosingAUsbAudioAdapter.md @@ -9,6 +9,6 @@ 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) +[<< Configuring PiPedal After Installation](Configuring.md) | [Up](Documentation.md) | [Optimizing Audio Latency >>](AudioLatency.md) diff --git a/docs/CommandLine.md b/docs/CommandLine.md index 0093dcc..794530c 100644 --- a/docs/CommandLine.md +++ b/docs/CommandLine.md @@ -17,5 +17,5 @@ Things you can do with pipedalconfig: Run `pipedalconfig --help` for available options. -------- -[<< Optimizing Audio Latency](AudioLatency.md) | [Changing the Web Server Port >>](ChangingTheWebServerPort.md) +[<< Optimizing Audio Latency](AudioLatency.md) | [Up](Documentation.md) | [Changing the Web Server Port >>](ChangingTheWebServerPort.md) diff --git a/docs/Configuring.md b/docs/Configuring.md index 039759a..c54b595 100644 --- a/docs/Configuring.md +++ b/docs/Configuring.md @@ -63,4 +63,4 @@ If you are connecting to PiPedal with an Android device, via the Host Access Poi -------- -[<< Installing PiPedal](Installing.md) | [Choosing a USB Audio Adapter >>](ChoosingAUsbAudioAdapter.md) +[<< Installing PiPedal](Installing.md) | [Up](Documentation.md) | | [Choosing a USB Audio Adapter >>](ChoosingAUsbAudioAdapter.md) diff --git a/docs/Debugging.md b/docs/Debugging.md index 87af6c6..fa51d99 100644 --- a/docs/Debugging.md +++ b/docs/Debugging.md @@ -122,4 +122,4 @@ 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 +[<< The Build System](TheBuildSystem.md) | [Up](Documentation.md) \ No newline at end of file diff --git a/docs/Installing.md b/docs/Installing.md index 3bc762c..0ab0c13 100644 --- a/docs/Installing.md +++ b/docs/Installing.md @@ -15,4 +15,4 @@ Install the package by running ``` -------- -[<< System Requirements](SystemRequirements.md) | [Configuring PiPedal after Installation >>](Configuring.md) \ No newline at end of file +[<< System Requirements](SystemRequirements.md) | [Up](Documentation.md) | [Configuring PiPedal after Installation >>](Configuring.md) \ No newline at end of file diff --git a/docs/SystemRequirements.md b/docs/SystemRequirements.md index 241ed1d..70b638f 100644 --- a/docs/SystemRequirements.md +++ b/docs/SystemRequirements.md @@ -14,4 +14,4 @@ PiPedal has been tested on the following Operating Systems: 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 +[Up](Documentation.md) | [Installing PiPedal >>](Installing.md) \ No newline at end of file diff --git a/docs/TheBuildSystem.md b/docs/TheBuildSystem.md index 63c622b..bd7e608 100644 --- a/docs/TheBuildSystem.md +++ b/docs/TheBuildSystem.md @@ -23,4 +23,4 @@ If you are using a development environment other than Visual Studio Code, it sho 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 +[<< Build Prerequisites](BuildPrerequisites.md) | [Up](Documentation.md) | [How to Debug PiPedal >>](Debugging.md) \ No newline at end of file diff --git a/docs/UsingLv2Plugins.md b/docs/UsingLv2Plugins.md index a63bd5e..f597637 100644 --- a/docs/UsingLv2Plugins.md +++ b/docs/UsingLv2Plugins.md @@ -21,4 +21,4 @@ For a more complete (but still incomplete) list of LV2 audio plugins, see [here] -------- -[<< Changing the Web Server Port](ChangingTheWebServerPort.md) | [Which LV2 Plugins Does PiPedal Support? >>](WhichLv2PluginsAreSupported.md) +[<< Changing the Web Server Port](ChangingTheWebServerPort.md) | [Up](Documentation.md) | [Which LV2 Plugins Does PiPedal Support? >>](WhichLv2PluginsAreSupported.md) diff --git a/docs/WhichLv2PluginsAreSupported.md b/docs/WhichLv2PluginsAreSupported.md index 13a5e4c..1f6277e 100644 --- a/docs/WhichLv2PluginsAreSupported.md +++ b/docs/WhichLv2PluginsAreSupported.md @@ -17,4 +17,4 @@ Although most LV2 plugins provide GUI interfaces, when running on a Linux deskto 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 +[<< Using LV2 Audio Plugins](UsingLv2Plugins.md) | [Up](Documentation.md) | [BuildingPiPedal from Source >>](BuildingPiPedalFromSource.md) \ No newline at end of file