Merge branch 'main' of https://github.com/rerdavies/pipedal

docs/BuildingPiPedalFromSource.md

@@ -7,12 +7,9 @@ page_icon: img/Compiling.jpg
 
 PiPedal has only been tested on Raspberry Pi OS, and Ubuntu, but should run with little or no modification on most Linux distributions. Pull requests to correct problems with building PiPedal on other versions of Linux are welcome. 
 
-To build PiPedal, a Raspberry Pi 4B, with at least 4GB of memory is required (8GB recommended). You can build PiPedal from the command-line using CMake; but the project was originally build using
-Microsoft Visual Studio Code. If you use VSCode, you will almost definitely need to hav 8GB of RAM.
+To build and debug PiPedal using Visual Studio Code, you need 8GB of memory. You can build PiPedal with 2GB of memory.
 
-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.
+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. However, management of ARM pakages on a Windows machine when cross-compiling is not great. Remote debugging may be a better path.
 
 --------
 [<< Which LV2 Plugins Does PiPedal Support?](WhichLv2PluginsAreSupported.md) | [Up](Documentation.md) | [Build Prerequisites >>](BuildPrerequisites.md)

docs/Debugging.md

@@ -108,6 +108,9 @@ You will need to add your userid to the pipedal_d group if you plan to share the
      
      sudo usermod -a -G pipedal_d *youruserid*
 
+You will need to reboot your machine to get the group membership change to take effect,or log out and log back
+in if you can do that.
+
 Or you can avoid all of this, by configuring the debug instance to use a data folder in your home directory. Edit 
 `debugConfig/config.json`:
 
@@ -117,5 +120,47 @@ Or you can avoid all of this, by configuring the debug instance to use a data fo
         ...
     }
 
+Run pipedald in a debugger, you need to use the following command-line to launch pipedal:
+
+    build/src/pipedald /etc/pipedal/config /etc/pipedal/react -port0.0.0.0:8080
+    
+The first argument specifies where the pipedal daemon's configuration files are. The second argument specifies where 
+built static web pages for the web application are. And the port option specifies the port on which the daemon will
+listen. If you are using a React debug server to serve up the web appliation you will point your browser at the 
+React debug server on port 3000; but the web application will still need to connect to web sockets on the 8080 port.
+
+If you are using Visual Studio Code, you might find it useful to add the following section to your `.vscode/launch.json` file:
+
+    {
+       ...
+       {
+            "name": "(gdb) pipedald",
+            "type": "cppdbg",
+            "request": "launch",
+            // Resolved by CMake Tools:
+            "program": "${command:cmake.launchTargetPath}",
+            "args": [   "/etc/pipedal/config",  "/etc/pipedal/react",  "-port", "0.0.0.0:8080"  ],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}",
+            "environment": [
+                {
+                    // add the directory where our target was built to the PATHs
+                    // it gets resolved by CMake Tools:
+                    "name": "PATH",
+                    "value": "$PATH:${command:cmake.launchTargetDirectory}"
+                }
+            ],
+            "externalConsole": false,
+            "MIMode": "gdb",
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                }
+            ]
+        },
+        ...
+    }
 -----
 [<< The Build System](TheBuildSystem.md) | [Up](Documentation.md)  | [PiPedal Architecture >>](Architecture.md)