From c8d81e450dcfce4f5852397310286b8be069140c Mon Sep 17 00:00:00 2001
From: Maschell <Maschell@gmx.de>
Date: Fri, 22 Apr 2022 22:03:57 +0200
Subject: [PATCH] Add documentation of build flags to the README

---
 Makefile  |  6 +++---
 README.md | 12 ++++++++++++
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index cc516af..340e881 100644
--- a/Makefile
+++ b/Makefile
@@ -46,9 +46,9 @@ CXXFLAGS += -DDEBUG -g
 CFLAGS += -DDEBUG -g
 endif
 
-ifeq ($(VERBOSE_DEBUG),1)
-CXXFLAGS += -DVERBOSE_DEBUG -g
-CFLAGS += -DVERBOSE_DEBUG -g
+ifeq ($(DEBUG),VERBOSE)
+CXXFLAGS += -DDEBUG -DVERBOSE_DEBUG -g
+CFLAGS += -DDEBUG -DVERBOSE_DEBUG -g
 endif
 
 LIBS	:= -lwups -lwut -lmappedmemory -lcontentredirection
diff --git a/README.md b/README.md
index 0cbd35c..d2ed841 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,18 @@ sd:/sdcafiine/0005000010145000/ModPack1/content/
 sd:/sdcafiine/0005000010145000/ModPack2/content/
 ```
 
+## Buildflags
+
+### Logging
+Building via `make` only logs errors (via OSReport). To enable logging via the [LoggingModule](https://github.com/wiiu-env/LoggingModule) set `DEBUG` to `1` or `VERBOSE`.
+
+`make` Logs errors only (via OSReport).  
+`make DEBUG=1` Enables information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).  
+`make DEBUG=VERBOSE` Enables verbose information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).  
+
+If the [LoggingModule](https://github.com/wiiu-env/LoggingModule) is not present, it'll fallback to UDP (Port 4405) and [CafeOS](https://github.com/wiiu-env/USBSerialLoggingModule) logging.
+
+
 ## Building using the Dockerfile
 
 It's possible to use a docker image for building. This way you don't need anything installed on your host system.