setup project structure

README.md

@@ -1,6 +1,6 @@
 # Gamayun
 
-![alt text](Gemini_Generated_Image_wv24iuwv24iuwv24.png)
+![alt text](resources/title_image.png)
 
 ## Concept
 
@@ -31,11 +31,73 @@ Client-Server Separation: Compute-intensive operations (embedding generation, LL
 - Deployment in air-gapped labs
 - Efficient resource utilization (centralized compute nodes can serve multiple investigators)
 
+## Development Setup
+
+## 🛠 Development Setup
+
+This project uses [uv](https://github.com/astral-sh/uv) for fast dependency management and the modern "Src Layout" structure.
+
+### Prerequisites
+
+- Python 3.13+
+- [uv](https://github.com/astral-sh/uv) installed (`curl -LsSf https://astral.sh/uv/install.sh | sh`)
+
+### Installation Steps
+
+1. **Clone the repository**
+
+   ```bash
+   git clone <your-repo-url>
+   cd gamayun
+   ```
+
+2. **Create a virtual environment**
+    This project requires Python 3.13.
+
+    ```bash
+    uv venv --python 3.13
+    ```
+
+3. **Activate the environment**
+
+      - Linux/macOS:
+
+        ```bash
+        source .venv/bin/activate
+        ```
+
+      - Windows:
+
+        ```powershell
+        .venv\Scripts\activate
+        ```
+
+4. **Install dependencies**
+    This command installs locked dependencies and links the local `gamayun` package in editable mode.
+
+    ```bash
+    uv pip install -r requirements.txt -e .
+    ```
+
+### Running the Application
+
+You can execute the module directly:
+
+```bash
+python src/gamayun/main.py
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
 ## Data Flow
 
 ### Ingestion Pipeline
 
-```
+```bash
 Raw Evidence Sources
 ├─ Forensic Images (E01, DD, AFF4)
 ├─ Timeline CSV (Timesketch format)
@@ -94,7 +156,7 @@ This manifest allows exact reproduction of the index from the same source data.
 
 ### Query Execution Pipeline
 
-```
+```bash
 Natural Language Query
 "bitcoin transaction after drug deal"
          │