Merge pull request Gagandeep-2003#48 from debug-soham/docs/add-model-download-instructions

Merged PR to improve documentation and setup clarity. Added mandatory model download instructions in README and CONTRIBUTING, updated blinkDetect.py with correct model path and comments to help new users avoid RuntimeError. Fixes Gagandeep-2003#45.

Author: Gagandeep-2003

CONTRIBUTING.md

@@ -8,6 +8,7 @@ First off, thank you for considering contributing to this project! Your help is
 
 ## 🛠️ Project Setup
 Follow these steps to get the project running on your local machine.
+
 ### 1. **Fork and Clone**
 1.  **Fork the repository**: Click the `Fork` button on the top right of the repo.
 2.  **Clone your fork**:
@@ -35,8 +36,9 @@ Follow these steps to get the project running on your local machine.
     ```bash
     pip install -r requirements.txt
     ```
-        
-3.  **Download the dlib model**: The blink detection feature requires a pre-trained model.
+
+3.  **Download the dlib facial landmark model**  
+    The blink detection feature requires a pre-trained model.
     * Download the file from [this link](https://dlib.net/files/shape_predictor_68_face_landmarks.dat.bz2).
     * Unzip it and place the `shape_predictor_68_face_landmarks.dat` file inside the `/models` directory.
 
@@ -73,6 +75,7 @@ Follow these steps to get the project running on your local machine.
 * Keep your code clean, readable, and well-commented where necessary.
 * Follow the existing naming conventions and code style.
 * Ensure each pull request addresses only one feature or bug fix.
+* Comment your code where needed.
 
 ## 🙌 Need Help?
 

README.md

@@ -55,7 +55,12 @@ source venv/bin/activate  # On Windows: venv\Scripts\activate
    ```bash
    pip install -r requirements.txt
    ```
-3. **Run the application:**
+3. **Download the model:**
+
+    The dlib facial landmark model is required for blink detection. Download it from the link below, unzip it, and place the `shape_predictor_68_face_landmarks.dat` file inside the `/models` directory.
+    * **Download Link**: [shape_predictor_68_face_landmarks.dat](https://dlib.net/files/shape_predictor_68_face_landmarks.dat.bz2)
+
+4. **Run the application:**
    ```bash
    python main.py
    ```

blinkDetect.py

@@ -20,7 +20,11 @@
 RESIZE_HEIGHT = 460
 
 thresh = 0.27
-modelPath = "models/shape_predictor_70_face_landmarks.dat"
+
+# IMPORTANT: You must download the shape_predictor_68_face_landmarks.dat file from
+# https://dlib.net/files/shape_predictor_68_face_landmarks.dat.bz2
+# and place it in the 'models' folder
+modelPath = "models/shape_predictor_68_face_landmarks.dat"
 sound_path = "alarm.wav"
 
 detector = dlib.get_frontal_face_detector()