From 8e93e2d154e18c6f647ed6e0cf55978f6ecd364b Mon Sep 17 00:00:00 2001
From: Salvatore <digirols@inf.ethz.ch>
Date: Sat, 1 May 2021 17:35:13 +0200
Subject: [PATCH] docs

---
 docs/compile.md | 31 +++++++++++++++++++++++++++++++
 mkdocs.yml      |  5 +++++
 2 files changed, 36 insertions(+)
 create mode 100644 docs/compile.md

diff --git a/docs/compile.md b/docs/compile.md
new file mode 100644
index 0000000..b16fd46
--- /dev/null
+++ b/docs/compile.md
@@ -0,0 +1,31 @@
+# Verilating the hardware
+
+Verilating the hardware is needed whenever you want test new hardware changes that are not available in the relased packeges. The verilation process can take quite long time (20-30 minutes on a Xeon X7550) and can require up to 16 GB of memory. Consider to use the prebuilt libraries if they fit your use case. 
+
+### Requirements:
+Verilator >= 4.108
+
+### 1) Clone the repository
+
+```bash
+git clone https://github.com/spcl/pspin
+```
+
+### 2) Define `VERILATOR_HOME`
+```bash
+export VERILATOR_HOME=<path to verilator installation>
+```
+
+### 3) Verilate
+
+```bash
+cd hw/verilator_model/
+
+# Compile `libpspin.so`
+make release
+
+# (Optional) Compile `libpspin_debug.so`
+make debug
+```
+
+
diff --git a/mkdocs.yml b/mkdocs.yml
index a638fd1..c1e886b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,3 +1,8 @@
+site_name: PsPIN
+repo_url: https://github.com/spcl/pspin
+theme: 
+    name: material 
+
 nav:
     - Home: 'index.md'
     - Getting started: