From 3eb5e3de02b6fb12f8327289bbdcb6c7b651886e Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Thu, 12 Mar 2020 17:01:25 +0100
Subject: [PATCH] Mention how to attach a debugger

---
 README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a4ec568e..4ab1f9d4 100644
--- a/README.md
+++ b/README.md
@@ -85,8 +85,7 @@ ninja -C build
 ```
 
 When developing or debugging yabridge you can change the build type to either
-`debug` or `debugoptimized` to enable debug symbols and optionally also disable
-optimizations.
+`debug` enable debug symbols and disable optimizations.
 
 ## Debugging
 
@@ -115,6 +114,17 @@ variables:
   More detailed information about these levels can be found in
   `src/common/logging.h`.
 
+### Attaching a debugger
+
+When needed, I found the easiest way to debug the plugin to be to load it in an
+instance of Carla with gdb attached:
+
+```shell
+env YABRIDGE_DEBUG_FILE=/tmp/yabridge.log YABRIDGE_DEBUG_LEVEL=1 carla --gdb
+```
+
+I sadly haven't had any luck with winedbg for debugging the winelib binary.
+
 ## Rationale
 
 I started this project because the alternatives were either unmaintained, not