Skip to content

Commit a4acc50

Browse files
Update README.md
1 parent f0084a7 commit a4acc50

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
- Fatigue and drowsiness detection algorithm
44
- Timely alerts to prevent the driver from falling asleep
55
- Non-intrusive and easy to set up
6-
- **📱 Progressive Web App (PWA) support - Install like a native app!**
7-
- **🔄 Offline functionality with caching**
8-
- **🚀 Fast loading with optimized performance**on System
6+
- Progressive Web App (PWA) support - Install like a native app!
7+
- Offline functionality with caching
8+
- Fast loading with optimized performance on System
99

1010
<p align="center">
1111
<img src="https://img.shields.io/github/stars/Gagandeep-2003/Driver-Drowsiness-Detection-System?style=social" alt="GitHub stars" />
@@ -68,17 +68,35 @@ source venv/bin/activate # On Windows: venv\Scripts\activate
6868

6969
## Folder Structure
7070
```
71-
Driver-Drowsiness-Detection-System/
72-
├── drowsiness_detector/
73-
│ ├── detector.py
74-
│ └── utils.py
75-
├── models/
76-
│ └── shape_predictor_68_face_landmarks.dat
77-
├── assets/
78-
│ └── demo.gif
79-
├── main.py
80-
├── requirements.txt
81-
├── README.md
71+
driver-drowsiness-detection-system/
72+
73+
├── main.py # Entry point for the system
74+
├── blinkDetect.py # Drowsiness detection script
75+
├── lanedetection.py # Lane detection module
76+
├── ui.py # User interface handling
77+
├── requirements.txt # Python dependencies
78+
├── CONTRIBUTING.md # Contribution guidelines
79+
├── DEPLOYMENT.md # Deployment instructions
80+
├── PWA_README.md # PWA installation & usage
81+
├── PWA_IMPLEMENTATION.md # Technical details of PWA
82+
83+
├── models/ # Pre-trained ML models
84+
│ └── haarcascade_frontalface_default.xml
85+
86+
├── streamlit_app/ # Web app (Streamlit + PWA)
87+
│ ├── streamlit_app.py
88+
│ ├── streamlit_app_pwa.py
89+
│ ├── manifest.json
90+
│ ├── sw.js
91+
│ └── icons/ # App icons for PWA
92+
93+
├── assets/ # Images, audio, and test files
94+
│ ├── alarm.wav
95+
│ ├── alarm.mp3
96+
│ ├── eye.PNG
97+
│ ├── eye_aspect_ratio.PNG
98+
│ ├── face.PNG
99+
│ └── test_image.jpg
82100
83101
```
84102

0 commit comments

Comments
 (0)