From 053e3b526655b57b4b2007726ad50e690f0014b8 Mon Sep 17 00:00:00 2001
From: gberkes <gabor@berkes.me>
Date: Sun, 4 Aug 2024 22:13:58 +0200
Subject: [PATCH] Document the usage and the importance of assertions.

---
 README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 36201735..704967d6 100644
--- a/README.md
+++ b/README.md
@@ -236,10 +236,16 @@ CFLAGS to disable the compilation optimization parameters:
 ```shell
 $ export CFLAGS="-g -O0"
 $ ./build.sh
-$ ./configure
+$ ./configure --enable-assertions=yes
 $ make
 $ sudo make install
 ```
+"Assertions allow us to document assumptions and to spot violations early in the
+development process. What is more, assertions allow us to spot violations with a
+minimum of effort." https://dl.acm.org/doi/pdf/10.1145/240964.240969
+
+It is recommended to use assertions where applicable, and to enable them with
+'--enable-assertions=yes' during the testing and debugging workflow.
 
 ### Benchmarking