diff --git a/README.md b/README.md index da4c776..0a0192a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # Traffic Light Detector +Traffic Light recognition and color detection ![Tests](https://github.com/kristoferssolo/Traffic-Light-Detector/actions/workflows/tests.yml/badge.svg) + +## Description +See [DESCRIPTION.md](./DESCRIPTION.md) + +![Red light](./media/red.jpg) + +## Installation + +```shell +git clone https://github.com/kristoferssolo/Traffic-Light-Detector +cd Traffic-Light-Detector +pip install . +``` + +## Examples +`./main.py` -- Creates necessary directories in `/assets/` +`./main.py -i` -- Detects traffic lights and their signal color for all files located in `/assets/images_in/` and saves them in `/assets/images_out/`. +`./main.py -c ` -- Uses webcam or any camera to detect traffic lights in real time. +`./main.py -sc ` -- Plays sound file located in `/assets/sound/move.mp3` whenever green light signal is detected via camera. + +Replace `` with your camera number specified by the operating system. Probably `0` or `1`, but can be higher. + +## To Do +- [ ] Write unit tests. +- [ ] Create/find better traffic light model for better traffic light recognition. diff --git a/media/red.jpg b/media/red.jpg new file mode 100644 index 0000000..ef8afa9 Binary files /dev/null and b/media/red.jpg differ