added basic setup instructions

This commit is contained in:
R Dittberner 2024-09-14 20:47:15 +02:00
parent 8fa61fe356
commit d70601e7e3

6
SETUP.md Normal file
View file

@ -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`