User Story
As a developer setting up the project,
I want the README.md to clearly document all non-Python dependencies required for OpenCV (like ffmpeg)
so that installation errors related to missing system packages are prevented.
Background
The current README.md only lists Python dependencies via setup.py (e.g., opencv-python). OpenCV requires ffmpeg for video processing, which is not explicitly mentioned. This gap causes failures during VideoCapture initialization in video_describer.py for users without ffmpeg installed. New contributors and users report installation issues, especially on fresh environments.
Acceptance Criteria
User Story
As a developer setting up the project,
I want the README.md to clearly document all non-Python dependencies required for OpenCV (like ffmpeg)
so that installation errors related to missing system packages are prevented.
Background
The current README.md only lists Python dependencies via
setup.py(e.g.,opencv-python). OpenCV requires ffmpeg for video processing, which is not explicitly mentioned. This gap causes failures duringVideoCaptureinitialization invideo_describer.pyfor users without ffmpeg installed. New contributors and users report installation issues, especially on fresh environments.Acceptance Criteria
README.mdunder the "Installation" section to include:sudo apt-get install ffmpegfor Ubuntu,brew install ffmpegfor macOS).cv2.VideoCapturefailures invideo_describer.py.