From 998ffa981fee23b963ec9c48c489c7716f1293f2 Mon Sep 17 00:00:00 2001
From: Jonas Gunz <himself@jonasgunz.de>
Date: Sun, 19 Sep 2021 23:47:39 +0200
Subject: Readme

---
 Readme.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

(limited to 'Readme.md')

diff --git a/Readme.md b/Readme.md
index 82bbbb6..01cad92 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,5 +1,40 @@
 # DNS
 
-A simple authorative DNS server implementation in c
+A simple authorative DNS server implementation in C89.
+
+This is a work-in-progress.
+
+## Building
+
+Build with
+
+´´´
+make build
+´´´
+
+executable is in `build/dnsd`
+
+## Testing
+
+always run `make clean` before and after compiling tests.
+
+### Run all tests
+
+```
+make test
+```
+
+### Coverage
+
+```
+make coverage
+```
+
+### Valgrind
+
+Run tests with Valgrind to check for memory leaks
+```
+make valgrind_test
+```
 
 License: MIT
-- 
cgit v1.2.3