From a1d5cbd9a9017cb545c96d747d9b00aa608c0457 Mon Sep 17 00:00:00 2001
From: gabrielmer <101006718+gabrielmer@users.noreply.github.com>
Date: Fri, 23 Feb 2024 16:25:13 +0200
Subject: [PATCH] chore: adding NIMFLAGS usage to readme (#2469)

---
 Makefile  | 1 +
 README.md | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/Makefile b/Makefile
index 9765de900..c1745d535 100644
--- a/Makefile
+++ b/Makefile
@@ -57,6 +57,7 @@ TARGET ?= prod
 
 ## Git version
 GIT_VERSION ?= $(shell git describe --abbrev=6 --always --tags)
+## Compilation parameters. If defined in the CLI the assignments won't be executed
 NIM_PARAMS := $(NIM_PARAMS) -d:git_version=\"$(GIT_VERSION)\"
 
 ## Heaptracker options
diff --git a/README.md b/README.md
index 87c6c4c02..a74db00a1 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,10 @@ The standard developer tools, including a C compiler, GNU Make, Bash, and Git. M
 # You'll run `make update` after each `git pull` in the future to keep those submodules updated.
 make wakunode2
 
+# Build with custom compilation flags. Do not use NIM_PARAMS unless you know what you are doing.
+# Replace with your own flags
+make wakunode2 NIMFLAGS="-d:chronicles_colors:none -d:disableMarchNative"
+
 # Run with DNS bootstrapping
 ./build/wakunode2 --dns-discovery --dns-discovery-url=DNS_BOOTSTRAP_NODE_URL