From 9ba28270d5f56b1d7ad766a0f9fe3a217aa20963 Mon Sep 17 00:00:00 2001
From: Marc <foxtrot@malloc.me>
Date: Fri, 28 Jan 2022 23:59:31 +0000
Subject: misc: Update README to include details about debug builds

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 846ec94..3b22eee 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ It is written with a simple-to-use approach while also exposing features that al
 The library is fully documented with code comments in both the headers files and the code files.
 
 ## Building and Installing
-### Linux
+### Building as Release
 ```
 $ mkdir build
 $ cd build
@@ -21,6 +21,15 @@ $ cmake ..
 $ make
 $ sudo make install
 ```
+### Building as Debug
+You can also specify `-DCMAKE_BUILD_TYPE=Debug` to CMake, to generate a library with debug symbols present. This also sets the library version number to `dev-BRANCHNAME-COMMITHASH`.
+```
+$ mkdir build
+$ cd build
+$ cmake .. -DCMAKE_BUILD_TYPE=Debug
+$ make
+$ sudo make install
+```
 
 ## Examples
 Some examples are available in the `examples/` directory, which show the general flow of how libwifi is used to generate and parse different types of 802.11 frame.
-- 
cgit 1.4.1