From b807396de868e7728136a506788b7ce8fe3c41a7 Mon Sep 17 00:00:00 2001
From: charlene tau express <charlene.tan@tauexpress.com>
Date: Mon, 17 Mar 2025 16:04:38 +0800
Subject: [PATCH] added readme file

---
 .env      |  2 --
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+), 2 deletions(-)
 delete mode 100644 .env
 create mode 100644 README.md

diff --git a/.env b/.env
deleted file mode 100644
index b6e55fe..0000000
--- a/.env
+++ /dev/null
@@ -1,2 +0,0 @@
-TOKENIZER_FOLDER=/home/charlenewsl/model-files/tokenizer
-MODEL_FOLDER=/home/charlenewsl/model-files
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..619cbbe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+## How to Run This Project
+
+### 1️⃣ Create and Activate a Virtual Environment
+
+Run the following command to create a virtual environment:
+
+```sh
+python -m venv venv
+```
+### Activate the Virtual Environment
+
+**On macOS/Linux:**
+  ```sh
+  source venv/bin/activate
+```
+### 2️⃣ Install Dependencies
+
+After activating the virtual environment, install the required packages:
+
+```sh
+pip install -r requirements.txt
+```
+
+
+### 3️⃣ Run the Flask Application
+
+Once dependencies are installed, start the Flask app by running:
+
+```sh
+python src/app.py
+```
+
+## Environment Variables
+
+This project requires a `.env` file for configuration.
+
+### **.env File Placement**
+- Place the `.env` file **one folder before** the `util` directory.
+- Example folder structure:
+### **Example `.env` File**
+```ini
+QDRANT_HOST = "localhost"
+QDRANT_PORT = 6333
+QDRANT_API_KEY=''
+QDRANT_CLUSTER=''
+QDRANT_COLLECTION_NAME='titan'
+TOKENIZER_FOLDER=''
+MODEL_FOLDER=''
+