From fdd17bc528ad90a276e8f6b3ce79318400c5b522 Mon Sep 17 00:00:00 2001
From: Jan Eitzinger <jan.eitzinger@fau.de>
Date: Mon, 17 Aug 2020 16:07:58 +0200
Subject: [PATCH] Extend README

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ce77d8e..bdb95e0 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,16 @@
 # MD-Bench
-A simple modular molecular dynamics benchmark
+
+A simple, sequential  C version of the Mantevo miniMD benchmark.
+
+## Build
+
+1. Open the `Makefile` and edit the `TAG` value according to the tool chain used. Currently supported is GCC, CLANG (LLVM), and ICC (Intel).
+2. Open and adapt the compiler flags in `<include_<TOOLCHAIN>.mk`, e.g. in `include_ICC.mk` for the Intel tool chain.
+3. Build the binary calling `make`.
+
+You can clean intermediate build results with `make clean`, and all build results with `make distclean`.
+You have to call `make clean` before `make` if you changed the build settings.
+
+## Configuration
+
+Currently all settings are hard-coded in `main.c`.