From d70601e7e399b2ef20a8145c2067d2213d31a861 Mon Sep 17 00:00:00 2001
From: raphael <raphael@dittberner.info>
Date: Sat, 14 Sep 2024 20:47:15 +0200
Subject: [PATCH] added basic setup instructions

---
 SETUP.md | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 SETUP.md

diff --git a/SETUP.md b/SETUP.md
new file mode 100644
index 0000000..c5915e7
--- /dev/null
+++ b/SETUP.md
@@ -0,0 +1,6 @@
+# Setup Guide
+
+1. Set up python3 venv using `python3 -m venv /path/to/new/virtual/environment && source <venv>/bin/activate` (this should be in your local copy of the repository)
+2. Install python dependencies using `pip install -r requirements.txt`
+3. Write udtconfig.yml. (Use udtconfig_template.yml as a base)
+4. Run tool using `python3 main.py --help`
\ No newline at end of file