README.md

README.md

@@ -0,0 +1,54 @@
+# Leffa Project
+
+## Steps to Access and Run Files from the Hugging Face Repository
+
+### 1. Open VS Code
+Open **Visual Studio Code** on your computer.
+
+### 2. Clone the Repository
+- Open the **VS Code terminal**:
+    - Press `Ctrl + ~` on **Windows/Linux**
+    - Press `Cmd + ~` on **macOS**
+- Run the following command to clone the repository:
+    ```bash
+    git clone https://huggingface.co/dhairya16/leffa.git
+    cd leffa
+    ```
+
+### 3. Open the Project in VS Code
+- In the **VS Code terminal**, run:
+    ```bash
+    code .
+    ```
+    This will open the `leffa` folder in VS Code.
+
+### 4. Open app.py and test.py
+- In VS Code, go to the **Explorer**:
+    - Press `Ctrl + Shift + E`
+- Locate and open `app.py`.
+- Locate and open `test.py`.
+
+### 5. Run test.py in VS Code Terminal
+- Open the **VS Code terminal**:
+    - Press `Ctrl + ~`
+- Run the following command to execute `test.py`:
+    ```bash
+    python test.py
+    ```
+    - If you're using **unittest**, run:
+    ```bash
+    python -m unittest test.py
+    ```
+    - If you're using **pytest**, run:
+    ```bash
+    pytest test.py
+    ```
+
+---
+
+- Make sure you have the required dependencies installed in your environment.  
+- If you don't have `pytest` or `unittest` installed, use:
+    ```bash
+    pip install pytest
+    ```
+