Modified README.md

README.md

@@ -1 +1,42 @@
 # Image sorter
+
+# Installation
+
+Requires `python >=3.7`
+
+1. Create a python virtual environment
+
+```
+python -m venv venv
+```
+
+2. Activate the virtual environment
+
+```
+./venv/Scripts/activate
+```
+
+3. Install dependencies
+
+```
+pip install -r requirements.txt
+```
+
+# How to use
+
+--source" help="Path to the input folder containing the images"
+
+--destination" help="Path to the pass folder for images that pass the test"
+
+--rejects help="Path to the reject folder for images that fail the test"
+
+```
+python cli.py --source <image folder path> --destination <pass folder> --rejects <reject folder>
+```
+
+# TODO
+
+- Sort images according to size
+- Remove black or blank images
+- Remove white/gray images
+- Use multithreading to increase performance

sorter/image_sorter.py

@@ -15,6 +15,8 @@ def process_image(image_path,pass_folder,reject_folder):
     filename = image_path.name
     image  = cv2.imread(str(image_path))
     gray = cv2.cvtColor(image, cv2.COLOR_BGR2GRAY)
+    
+    # threshold(src, dst, threshold value, max value, threshold type)
     _, threshold = cv2.threshold(gray, threshold_value, max_value, threshold_type)