search

akshitagupta15june / Face-X

Demonstration of different algorithms and operations on faces. Star the repo⭐
https://discord.gg/QapWBRZbVe
MIT License
697 stars 598 forks source link

Documentation Improvement to Readme.md file to include and update tutorial on how to use Face-X library #1808

Open rggan opened 1 month ago

rggan commented 1 month ago

The Readme.md file of the repository lacks a tutorial on how to use the Face-X features. There is a tutorial present in the README.md file of the facex-library, but may be difficult for newcomers to identify. Additionally there are some dependencies that are required to use the features but are not included in the tutorial.

I would like to update the Readme.md to include documentation on a tutorial example on how to use the cartoonify feature in Face-X. I would also update the tutorial to include installing modules required to run the example that were not mentioned in the tutorial such as imutils and matplotlib.

My reasoning for updating and including the tutorial is to create an open and easy environment for new users and developers.

github-actions[bot] commented 1 month ago

Hello @rggan, Thank you for generating an issue to this project! Please wait while we get back to you.