From 6597a3a36030ce5fd76685bf5e6217f79f72509f Mon Sep 17 00:00:00 2001
From: "an.tsouchlos" <an.tsouchlos@gmail.com>
Date: Wed, 9 Feb 2022 16:36:11 +0000
Subject: [PATCH] Added instruction to build and run the tests

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 06685ef..3077cc6 100644
--- a/README.md
+++ b/README.md
@@ -14,4 +14,26 @@ For example `One number: {:08}; And another one: {:05.3}` is preprocessed into `
 This is returned as a `std::array<char, N>`, where `N` is automatically evaluated. The only code executed at compile
 time then formats the numbers and writes them into their place in the array.
 
-Disclaimer: The actual formatting code is largely shamelessly stolen from `fmtlib`.
\ No newline at end of file
+Disclaimer: The actual formatting code is largely shamelessly stolen from `fmtlib`.
+
+## Building and running the tests
+
+1. Initialize the `googletest` framework submodule
+```bash
+$ git submodule update --init
+```
+
+2. Create the build directory
+```bash
+$ cmake -B build -S .
+```
+
+3. Build the project
+```bash
+$ cmake --build build/
+```
+
+4. Run the tests
+```bash
+$ ctest --test-dir build/
+```
\ No newline at end of file