From 593e9dbd54be44542736a649ed5a3cd80f485b2c Mon Sep 17 00:00:00 2001
From: David Nieder <david.nieder@cs.tu-dortmund.de>
Date: Thu, 3 Aug 2023 19:31:16 +0000
Subject: [PATCH] readme

---
 Readme.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/Readme.md b/Readme.md
index e69de29..ad6371e 100644
--- a/Readme.md
+++ b/Readme.md
@@ -0,0 +1,18 @@
+### Dependencies ###
+* Google Tests (```tests/CMakeList.txt``` assumes ```/usr/src/gtest```)
+* libbenchmark (https://github.com/google/benchmark)
+* libmalloc_count (https://github.com/bingmann/malloc_count)
+
+(set correct paths in ```benchmarks/CMakeList.txt```)
+
+* x86-64 CPU with ```avx``` and ```avx2``` extension
+(test with ```grep avx2 /proc/cpuinfo```)
+
+### Building ###
+```
+mkdir build
+cd build
+cmake ..
+make
+```
+All tests and benchmarks should be inside a new ```bin/``` folder.
-- 
GitLab