Merge pull request #47 from bptlab/feature/46-add-installation-guide

📚 extend README by installation guide

README.md

@@ -1,7 +1,33 @@
 # TracEX
 
+
+## Key Points
+
 This bachelorproject focuses on event log extraction from patient journeys using large-language models.
 
 Our project partner is mamahealth. More information about them can be found here: [mamahealth](https://www.mamahealth.io/)
 
 More information about the project will be released soon.
+
+
+## Set Up Guide
+
+### Download
+
+- Use git and run "git clone https://github.com/bptlab/TracEX" in the desired directory _(Using e.g. Git Bash)_
+
+### Installation
+
+- In the root directory of TracEX, run "install-dependencies-unix.sh" or "install-dependencies-windows.ps1" based on your operating system _(Using e.g. Terminal)_
+
+### Execution
+
+**Web-App:**
+- Run "python tracex/manage.py runserver" in the root directory of TracEX _(Using e.g. Terminal)_
+
+**Command-Line Tool:**
+- Run "python command_line_tool.py" in the root directory of TracEX _(Using e.g. Terminal)_
+
+### Pre-Commit
+
+- If you intend on expanding the code, please run "pre-commit install" in the root directory of TracEX _(Using e.g. Terminal)_