From bf33a8b06c78b1942ddbde3aa7aec536bf9eda5f Mon Sep 17 00:00:00 2001
From: Derek Christ <dchrist@rhrk.uni-kl.de>
Date: Fri, 29 Apr 2022 08:46:41 +0200
Subject: [PATCH] Add readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6ae5dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+## Usage
+```
+mkdir build
+cd build
+cmake .. -DDynamoRIO_DIR=[path to directory that contains DynamoRIOConfig.cmake]
+ccmake . # Optional: configure build options
+cmake --build . -j$(nproc)
+```
+The `dram_tracer_launcher` is an offline tool that operates on DrCacheSim trace files:
+```
+./dram_tracer_launcher -trace_dir [path to trace directory]
+```
+For online usage (needed for physical address conversion), the tool has to be integrated into the DrCacheSim source code. A DynamoRIO fork is provided.
+To trace an application run the following command in the DynamoRIO build directory:
+```
+sudo ./drrun -t drcachesim -simulator_type dram_tracer -use_physical -- [application]
+```
+System priviledges are needed for the physical address conversion.