From d2ed5fde8a1fdf9ad450d8982f3fa77ebf602585 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Tue, 9 Jul 2024 20:52:41 +0200
Subject: [PATCH] Added developer notes to build README

---
 build/README.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/build/README.md b/build/README.md
index 98d87f1b..c48de2a8 100644
--- a/build/README.md
+++ b/build/README.md
@@ -2,7 +2,15 @@
 
 This directory collects all the output of make builds.
 
-## Instructions
+## Developing notes
+
+The configurable version of the package introduces some execution wrappers. These raise no problems on a normal execution work-flow, but they affect debug executions. The correct way to perform a debug run, therefore, is to enter the folder where the executable program is and then issue:
+
+   > ../libtool --mode=execute DEBUGGER_NAME EXECUTABLE_NAME
+
+where `DEBUGGER_NAME` is the preferred debugger (e.g. `gdb`, `ddd` ...) and `EXECUTABLE_NAME` is the program to be debugged.
+
+## Instructions (deprecated)
 
 The original code produces output in the current working directory (the path where the code is executed from). The build directory is intended to collect local builds and test run output in a safe place, without cluttering the code development folders, thus helping `git` to filter out unnecessary logs through `.gitignore`.
 
-- 
GitLab