From 8ffbe8ab54483247b41026417ea5aa32191f13b1 Mon Sep 17 00:00:00 2001
From: jakeg00dwin <jakegoodwin@gorge.works>
Date: Sat, 2 Mar 2024 10:25:36 -0800
Subject: [PATCH] updated the Doxygen configuration file and readme

---
 Doxyfile  |  4 ++--
 README.md | 14 ++++++++++++++
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/Doxyfile b/Doxyfile
index 4391adf..7a37c01 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -949,7 +949,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./src
+INPUT                  = ./src/ 
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1045,7 +1045,7 @@ FILE_PATTERNS          = *.c \
 # be searched for input files as well.
 # The default value is: NO.
 
-RECURSIVE              = NO
+RECURSIVE              = YES
 
 # The EXCLUDE tag can be used to specify files and/or directories that should be
 # excluded from the INPUT source files. This way you can easily exclude a
diff --git a/README.md b/README.md
index 672e1f6..002c6c9 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,20 @@ A template for C and CPP programming that makes use of the cmocka unit testing f
 
 ## Resources
 
+## Documentation
+
+Documentation genreation is handled with Doxygen.
+
+**Building documentation**
+```sh
+doxygen ./Doxyfile
+# Magic happens
+ls ./docs
+```
+And that's it.
+
+
+
 ## Contributions