From c78defb16791890e125ab66384afd927d91961df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A9lix=20Baylac-Jacqu=C3=A9?= <felix@alternativebit.fr>
Date: Fri, 4 Mar 2022 19:35:32 +0100
Subject: [PATCH] Add (very) short README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..56987f7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Nix/Guix Substitution Efficiency Benchmark
+
+This benchmark consists in a data acquisition part (`./compareSubsEfficiency`) and a data processing part, a Jupyter Notebook (`./analysis-notebook/Analysis.ipynb`).
+
+You can perform the data acquisition with:
+
+```sh
+./compareSubsEfficiency analysis-notebook/bench-results
+```
+
+You can perform the data processing with:
+
+```sh
+cd analysis-notebook
+nix-shell
+jupyter-lab
+```