From 46cf28a921adc31ab8d326974d5839bb3ba0ecc8 Mon Sep 17 00:00:00 2001
From: divaldo <divaldo@noreply.divaldo.hu>
Date: Wed, 6 Jun 2018 13:43:38 +0200
Subject: [PATCH] README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..70af62c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Track reconstruction from database export
+## Prerequisities
+* System which runs CERN Root (Tested on MacOS High Sierra 10.13.4)
+* CERN Root (Tested on 6.13/03)
+
+## Build and run
+* Clone this repository
+
+```
+git clone https://git.divaldo.hu/divaldo/DB_Track.git
+```
+* Create a working directory or use the Debug folder which already contains a data file
+* If you decided to use another folder, then copy the data.txt to it
+* You can use make -jN to use N number of CPU cores to build the app
+
+```
+cd DB_Track/Debug
+cmake ../
+make
+```
+* If complete, you can run it with the following command:
+
+```
+./DB_Track
+```
+* Use Ctrl + C to exit
+
+## If you have newer data
+* Export format is CSV
+* Columns separated with space (" ")
+* Columns enclosed with nothing
+* Columns escaped with nothing
+* The query order: ch_id, time_sec, time_ns, peak_amp
+* Ascending by time_sec and time_ns
\ No newline at end of file