I recently took a look at the project and noticed that setting it up locally might be a bit tricky for users due to missing dependencies and unclear documentation.
Firstly, I suggest creating a requirements.txt file with specified versions of the required packages. This will ensure that everyone who wants to run the project locally will have the exact dependencies needed. Here's the updated requirements.txt:
while trying it to setup I figure out below pkgs are required for me to install
Additionally, it would be helpful to update the README.md file with clear instructions on how to set up the project locally. This should include steps for installing the necessary dependencies, setting up ffmpeg or avconv, and any other prerequisites. Providing a step-by-step guide will make it much easier for new users to get started with the project.
I would more than happy to contribute with updating the documentation. But as I am getting started with codebase I will require some guidance
I recently took a look at the project and noticed that setting it up locally might be a bit tricky for users due to missing dependencies and unclear documentation.
requirements.txt
file with specified versions of the required packages. This will ensure that everyone who wants to run the project locally will have the exact dependencies needed. Here's the updated requirements.txt:while trying it to setup I figure out below pkgs are required for me to install
Additionally, it would be helpful to update the
README.md
file with clear instructions on how to set up the project locally. This should include steps for installing the necessary dependencies, setting up ffmpeg or avconv, and any other prerequisites. Providing a step-by-step guide will make it much easier for new users to get started with the project.I would more than happy to contribute with updating the documentation. But as I am getting started with codebase I will require some guidance