diff --git a/README.md b/README.md index abc26d4..8b83c70 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # Face-Recognition -#Hello I am in! Hello I am amit +This project is made using face-recognition library with opencv and frontend is developed using flask framework. + +## Requirements +* This model requires latest version of python. +* It requires dlib library which is coded in c++ and requires installation of visual studio with developer tools in c++. +* All other libraries have to be imported from text file requirements.txt + +## Files Description +* Templates - This folder has html files which are used in hosting of this model. + * index.html - This webpage is made using bootstrap. It is first page which contains START button which redirect to final.html. On the top it has a navigation bar which has admin controls(yet to be made). + * final.html - This webpage has a window to show webcam with your name and also has a END button which redirects the user to index.html and stops the webcam. +* app.py - It is a python file which has all the code related to face-recognition model. +* ImageBasics - This folder contains all the images which the model can recognise. + +## Refrences +* https://pypi.org/project/face-recognition/ +* https://flask.palletsprojects.com/en/2.0.x/ +* https://getbootstrap.com/docs/5.0/getting-started/introduction/ + +## Team Members +* Amit Kumar Makkad +* Bhavya Contractor +* Priyansh Jaseja