From 5f722e4efe72eec569fb5f90e603f09bc7b3e0cf Mon Sep 17 00:00:00 2001
From: "T.Jerosch" <thorsten.jerosch@gmx.de>
Date: Wed, 20 May 2020 21:42:26 +0200
Subject: [PATCH] added readme

---
 Readme.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..47cb096
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,19 @@
+# Tesla2Csv
+
+This converter-script is an addition to a maven profiler called "tesla-profiler".
+A version of the profiler can be found for example here: 
+* https://github.com/takari/maven-profiler
+* https://mvnrepository.com/artifact/io.tesla.profile/tesla-profiler
+* ...
+
+To install the profiler, simply place the jar file inside `$MVN_HOME/lib/ext`
+
+Then you can run the profiler and save the output to a file:
+`mvn clean install -Dmaven.profile > profile.log 2>&1`
+
+From the created output, extract the profiling section.
+See `profile.log` for an example.
+
+In order to convert the output to CSV, simply run the Perl script: `./convert.pl`
+
+At the moment there are no arguments, if you want to change the in- or output file, you have to edit the script.