From efeec429911f751d7b21d9a7338e33fcfcd0e9c1 Mon Sep 17 00:00:00 2001
From: Christian Halaszovich <chalaszovich@gmail.com>
Date: Tue, 17 Sep 2019 17:31:14 +0200
Subject: [PATCH] Added README.

---
 PTU2BIN.sln |  1 +
 README.txt  | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+)
 create mode 100644 README.txt

diff --git a/PTU2BIN.sln b/PTU2BIN.sln
index 414b263..78b54b8 100644
--- a/PTU2BIN.sln
+++ b/PTU2BIN.sln
@@ -9,6 +9,7 @@ Project("{888888A0-9F3D-457C-B088-3A5042F75D52}") = "convertPTUs", "convertPTUs\
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{0405B853-71DC-4EB3-B082-8CA6AD8E791B}"
 	ProjectSection(SolutionItems) = preProject
+		README.txt = README.txt
 		TODO.txt = TODO.txt
 	EndProjectSection
 EndProject
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..d8f4674
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,20 @@
+2019-09-17
+Copyright by Christian R. Halaszovich
+
+Tools to convert PicoQuant PTU files (as written by e.g. SymphoTime64) to
+BIN files containing pre-histogrammed data. This works for FLIM data in
+T3 format.
+
+The number of supported formats is quite limited as of now. Fell free to
+get in touch with me if you need addional formats supported. (PTU-files
+can differ somewhat in the internal format they use.)
+
+There are two tools provided:
+PTU2BIN - This is the conversion tool an can be used to convert single files.
+          (The original file is preserved, of course.) Some useful info is
+		  put out by the tool.
+convertPTUs.py - A Python script that batch-converts all ptu files in the current
+                 directory and its sub-directories and converts them using
+				 PTU2BIN. By default the output from PTU2BIN is written to
+				 individual txt-files. There is a command-line switch to
+				 send the output of PTU2BIN to the terminal instead.