From 6e8146bd8a3db4e7f53e4d3919662de22e828764 Mon Sep 17 00:00:00 2001
From: "James O. D. Hunt" <jamesodhunt@gmail.com>
Date: Sun, 24 Nov 2024 11:46:40 +0000
Subject: [PATCH] docs: Add skeletal developer document

Signed-off-by: James O. D. Hunt <jamesodhunt@gmail.com>
---
 README-DEVELOPER.md | 18 ++++++++++++++++++
 README.md           |  4 ++++
 2 files changed, 22 insertions(+)
 create mode 100644 README-DEVELOPER.md

diff --git a/README-DEVELOPER.md b/README-DEVELOPER.md
new file mode 100644
index 0000000..7221fe0
--- /dev/null
+++ b/README-DEVELOPER.md
@@ -0,0 +1,18 @@
+# procenv developer details
+
+> **Note:**
+>
+> This document assumes you have already read the
+> [build document](README-BUILD.md).
+
+## Debug with gdb or lldb
+
+To disable optimisations when building `procenv`, configure by specifying
+the `--disable-compiler-optimisations` configure option (which sets the
+`-O0` compiler option):
+
+```bash
+$ /configure --disable-compiler-optimisations
+$ make
+$ gdb src/procenv
+```
diff --git a/README.md b/README.md
index 0a439d0..9924418 100644
--- a/README.md
+++ b/README.md
@@ -141,6 +141,10 @@ applications.
 For instructions on building from source, see also the
 [build document](README-BUILD.md).
 
+## Developer documentation
+
+See the [developer document](README-DEVELOPER.md).
+
 ## Install
 
 ### Snap