aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Readme.md37
1 files changed, 36 insertions, 1 deletions
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