Update README.md

This commit is contained in:
Kristofers Solo 2022-12-24 11:55:54 +02:00
parent a04e5023e1
commit cce179a065
2 changed files with 26 additions and 0 deletions

View File

@ -1,3 +1,29 @@
# Traffic Light Detector # Traffic Light Detector
Traffic Light recognition and color detection
![Tests](https://github.com/kristoferssolo/Traffic-Light-Detector/actions/workflows/tests.yml/badge.svg) ![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 <int>` -- Uses webcam or any camera to detect traffic lights in real time.
`./main.py -sc <int>` -- Plays sound file located in `/assets/sound/move.mp3` whenever green light signal is detected via camera.
Replace `<int>` 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.

BIN
media/red.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB