From c4620768025bb25ca2dfcaacc5df909dd4df8521 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Th=C3=A9ophile=20Bastian?= <contact@tobast.fr>
Date: Mon, 26 Mar 2018 13:04:27 +0200
Subject: [PATCH] Document (future) behaviours

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8c981db..329db31 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
 # eh_frame_check_setup
 
-Testing setup for eh_frame_check, available at https://github.com/francesco-zappa-nardelli/eh_frame_check/
\ No newline at end of file
+Testing setup for `eh_frame_check`, available
+[here on GitHub](https://github.com/francesco-zappa-nardelli/eh_frame_check/)
+
+## Dependencies
+
+To run those scripts, you will need
+
+* A recent `gdb`, compiled with python support (I have python3 support, but I
+  expect it to work for python2)
+* `virtualenv`
+* `git`
+* some time ahead of you (it will compile stuff)
+
+## How to run
+
+On the first run, setup everything (this may take some time — we're compiling
+glibc and its whole testsuite here):
+
+```bash
+  ./setup_env.sh
+```
+
+Then, for every subsequent run, you can source the environment variables needed
+(this is not strictly necessary, but will help you debug stuff):
+
+```bash
+  source ./env
+```
+
+You may then either run a single test,
+
+```bash
+  ./run_single_test.sh math/test-misc  # Or any other glibc test path
+```
+
+or run the whole testsuite
+
+```bash
+  ./run_all_tests.sh
+```