From 03fa1716ebcfc3032bd1ec96b516ca14797490b9 Mon Sep 17 00:00:00 2001
From: "abir.chebbi" <abir.chebbi@hes-so.ch>
Date: Thu, 12 Sep 2024 15:48:47 +0200
Subject: [PATCH] update readme PART 2

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index e187f0e..074aeb4 100644
--- a/README.md
+++ b/README.md
@@ -61,3 +61,25 @@ The main.py script will:
 
 ## Part 2:
 
+### Set up environment
+
+Install required python libraries listed in the 'requirements.txt': 
+
+`pip3 install -r requirements.txt`
+
+### Step 1:  Create VM
+
+## Step 2: Running the app
+
+Launch the Streamlit application which interacts with the Vector Store , LLM for embeddings and LLM for text generation: 
+
+`streamlit run main.py -- --endpoint [YourVectorDBEndpoint] --index_name [YourIndexName]`
+
+Where:
+
+- **--endpoint**: Endpoint for the vector database.
+- **--index_name**: The index_name where to store the embeddings in the collection.
+
+## Step 3: Accessing the app:
+
+Once the app starts, navigate to this URL `http://[public_ip_adress_of_yourVM]:8501` in your web browser to start interacting with your chatbot. 
\ No newline at end of file
-- 
GitLab