From 59981aa2368146d0d8f8ca0480b3a375b1e11aa0 Mon Sep 17 00:00:00 2001
From: Tobias Langer <Tobias.Langer@oth-regensburg.de>
Date: Tue, 11 Oct 2016 21:37:42 +0200
Subject: [PATCH] Added readme.

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..70cd86c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Experiment Framework for EMB²
+
+## Overview
+
+This small toolkit helps with the automatic generation, building and execution
+of experiments. Currently it is limited to the generation of experiments for
+real-time tasksets for the EMB² library writtine in C++ (C++11); however, it
+should be easily extendable for other purposes, aswell.
+
+## Requirements
+
+Most of the scripts are written in Python (Python 3.5) and should therefore be
+usable on most operating systems. The following third-party libraries where
+used:
+
+* argparse
+* shutil
+* json
+* pystache
+
+Building and running the single experiments heavily relies on the buildutils and
+clang.
+
+## Usage
+
+All of the scripts have self-explaining usage messages, an exemplary experiment
+generation flow from generation to execution is given by the *run.sh* shell
+script.
--
libgit2 0.26.0