From 8a46a93e07ba80676d5fbdbf877835cdeaa6fcd4 Mon Sep 17 00:00:00 2001
From: Gabriel Studer <gabriel.studer@unibas.ch>
Date: Tue, 30 Jun 2020 10:20:05 +0200
Subject: [PATCH] update README

---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0e9a08d..59b3268 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
 # promod3_pipeline_benchmark
 
-Benchmark pipelines for the ProMod3 modelling engine
\ No newline at end of file
+This repository contains code and data to reproduce the figures and tables 
+from the benchmarking efforts in the manuscript: 
+"ProMod3 - A versatile homology modelling toolbox".
+
+The *modelling*, *loop*, *sidechain* and *other* directories contain detailed
+instructions on how to reproduce the numbers and figures.
+
+You need an OpenStructure and ProMod3 installation to run the scripts, 
+more specifically you need the *ost* and *pm* executables in your path.
+Furthermore you need the numpy, scipy and matplotlib Python modules. 
+
-- 
GitLab