Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
rggan opened this issue May 24, 2024 · 1 comment

Comments

@rggan
Copy link

rggan commented May 24, 2024

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.

Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant