chore: add readme

Signed-off-by: Matej Focko <mfocko@redhat.com>
2022-05-18 22:30:41 +02:00 · 2022-05-18 22:30:41 +02:00 · 33f820f8de
commit 33f820f8de
parent 02a7d5da0e
1 changed files with 13 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,13 @@
+# WAVL Tree Implementation
+
+## Used dependencies
+
+Dependencies are used mainly in tests, namely:
+
+- `hypothesis`
+- `pytest`
+
+## Running tests
+
+When finding a counter-example, hypothesis may generate **a lot** of DOT files
+with generated trees.