From 57ba224358dae96b5327dcab15ff8b24be207ee2 Mon Sep 17 00:00:00 2001
From: Piotr Biskup <piobis@st.amu.edu.pl>
Date: Wed, 16 Feb 2022 10:14:52 +0100
Subject: [PATCH] Add 'README.md'

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b5af5d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Face Mask Detection
+
+1. Clone repository
+2. Download dataset from: https://www.kaggle.com/andrewmvd/face-mask-detection
+3. In the project create folder 'data'
+4. Put 'annotations' and 'images' folders into 'data' folder
+5. You can now run project (it uses saved model 'face_mask_detection2.hp') or you can train model yoursel and to do that:
+- execute jupyter notebook 'data_preprocessing.ipynb' - data preprocessing
+- execute jupyter notebook 'train_model.ipynb' - it will overwrite face_mask_detection2.hp' file
+- run project
+
+
+To run project:
+
+```
+pip3 install virtualenv
+virtualenv venv
+source venv/bin/activate
+python3 -m pip install -r requirements.txt
+python3 detect_mask.py 
+```
\ No newline at end of file