From 92be6c23f1e8eebfacb84e860b838f3f6f15116a Mon Sep 17 00:00:00 2001
From: Jeremy <51220084+jeremy-rifkin@users.noreply.github.com>
Date: Fri, 15 Mar 2024 17:39:23 -0500
Subject: [PATCH] Update note about debug symbols being needed

---
 README.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index cb4bfa9..84e5809 100644
--- a/README.md
+++ b/README.md
@@ -141,14 +141,18 @@ thrown, and providing an API for safe tracing from signal handlers.
 
 # In-Depth Documentation
 
+## Prerequisites
+
+> [!IMPORTANT]
+> Debug info (`-g`/`/Z7`/`/Zi`/`/DEBUG`/`-DBUILD_TYPE=Debug`/`-DBUILD_TYPE=RelWithDebInfo`) is required for complete
+> trace information.
+
 ## `namespace cpptrace`
 
 `cpptrace::generate_trace()` can be used to generate a stacktrace object at the current call site. Resolved frames can
 be accessed from this object with `.frames` and also the trace can be printed with `.print()`. Cpptrace also provides a
 method to get lightweight raw traces, which are just vectors of program counters, which can be resolved at a later time.
 
-**Note:** Debug info (`-g`/`/Z7`/`/Zi`/`/DEBUG`) is generally required for good trace information.
-
 All functions are thread-safe unless otherwise noted.
 
 ### Stack Traces