From aa006ca17885d1b2cc5df76d8a8ef1a356aa529f Mon Sep 17 00:00:00 2001
From: Filipe Rodrigues <filipejacintorodrigues1@gmail.com>
Date: Wed, 12 Jul 2023 12:09:42 +0100
Subject: [PATCH] Added README to project.

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3dd3024
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# `ftmemsim`
+
+A tiered-memory simulator.
+
+# Usage
+
+To use this library, first clone it:
+
+```bash
+git clone https://github.com/Zenithsiz/ftmemsim
+```
+
+(If you need to generate traces, also clone the submodules with `--recurse-submodules`).
+
+After this, you can check `run-tracer.sh` for an example on how to trace a program. You'll need to compile the valgrind fork in `extern/ftmemsim-valgrind`. Follow the instructions on it's README for building.
+
+You'll also need the `parse-valgrind` rust tool. You can use the following to build it:
+
+```bash
+cargo build --release --package "parse-valgrind"
+```
+
+You can now run the simulator with these traces. Look in the `run.sh` file for examples, but it boils down to running the simulator itself:
+
+```bash
+cargo run --release --package ftmemsim -- \
+	--config <config-file> \
+	<trace-file> \
+	--output <output-file>
+```
+
+Finally you can use `ftmemsim-graphs` to generate some graphs from it's output. See `./ftmemsim-graphs --help` for a list of all the graphs. You can run, for example, the following:
+
+```bash
+cargo run --release --package ftmemsim-graphs -- \
+	page-migrations \
+	<simulator-output-file> \
+	--config <config-file> \
+	--output <output-image>
+```