From 0ca14b1fe988a3fe579242499657ec220d3c85ab Mon Sep 17 00:00:00 2001
From: itak1 <165740827+itak1@users.noreply.github.com>
Date: Tue, 15 Oct 2024 13:38:38 +1100
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aba6d22
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+Files used for 2024 Honours Project - Exploring the effect of beta-blockers on repolarisation parameters in Long QT Syndrome
+
+There are two folders currently:
+  Batch_Ishne_Conversion:
+    This folder contains all critical functions to convert ishne .ecg and .ann file formats to Arash formats for processing with the LQTS Holter Analysis folder. Developed by AS, refined by GP. BATCH_CONVERSION is the main script to run. Can handle multiple files if the folder is the selected path.
+  New_LQTS_Analysis_Program-Hons-2024
+    This folder is a bit of a misnomer. It can be used to analyse any Arash format ecg file, not just LQTS. BATCH_ARASH_FORMAT_ANALYSIS is the main script to run. analyse_ecg extracts parameters and LQTS_Program_Function perform tasks like heatmaps (LQTS_Program_Function).