From 4ff6b2cf23f17402a542b3d48c0b36ec47642a28 Mon Sep 17 00:00:00 2001
From: AnonymousREConfSubmission
 <127930083+AnonymousREConfSubmission@users.noreply.github.com>
Date: Wed, 15 Mar 2023 09:31:52 +0100
Subject: [PATCH] Update README.md

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 325c926..76f4563 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,37 @@
-# AQM-Interaction
\ No newline at end of file
+# AQM-Interaction
+Introduce the AQM
+
+**Note:** This work is based on the flask extension for direcly using WebVOWL from: https://github.com/ahmedkhemiri95/flask-WebVOWL. Therefore, Python (here in version 3.11.2) and Java (here in version 1.8.0) are prerequisites.
+
+## Installation
+Clone this repository on your machine:
+
+```cmd
+git clone https://github.com/AnonymousREConfSubmission/AQM-Interaction.git
+```
+
+Create a virtual Python environment for this project, e.g.
+
+```cmd
+python -m venv env
+```
+
+Activate the create environment, e.g. (Windows command)
+```cmd
+.\env\Scripts\activate
+```
+
+Install the needed libaries (e.g. flask and rdflib) using pip, e.g.
+```cmd
+pip install -r dependencies.txt
+```
+
+## Important Note
+The individually created AQM needs to be located in /XXXXX and must follow the conceptualization procedure from the paper. For demonstration purposes, the AQM from the case study of the paper was included in this repository.
+
+## Run the application
+Start the flask server
+```cmd
+python main.py
+```
+Open your browser at http://localhost:5000
-- 
GitLab