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

Update Readme #54

Closed
aasthakourav20 opened this issue May 20, 2024 · 5 comments · Fixed by #61
Closed

Update Readme #54

aasthakourav20 opened this issue May 20, 2024 · 5 comments · Fixed by #61
Assignees

Comments

@aasthakourav20
Copy link
Contributor

What's missing in this repository!!

A README file is essential in any given repository because it serves as the primary source of information about the project. It provides an overview of the project's purpose, how to install and use it, and any necessary prerequisites. Additionally, the README often includes guidelines for contributing, links to documentation, and contact information for the maintainers. This file ensures that both new and returning users can easily understand the project's scope, setup, and usage, thereby enhancing the project's accessibility and fostering collaboration. By consolidating all critical information in one place, a README file significantly improves the user experience and facilitates effective project management.

Kindly assign this issue to me under GSSoC'24

Copy link

Thank you for creating this issue! 🎉 We'll look into it as soon as possible. In the meantime, please make sure to provide all the necessary details and context. If you have any questions or additional information, feel free to add them here. Your contributions are highly appreciated! 😊

You can also check our CONTRIBUTION.md for guidelines on contributing to this project.

@TusharAMD
Copy link
Owner

What are things missing from readme we have right now?

@aasthakourav20
Copy link
Contributor Author

Hey @TusharAMD , we can add specific project features to the readme , helps the contributors to go through in single run rather than paragraphs . And I think Installation steps are incomplete and undescriptive , all these things should be taken care in contributors point of view .

@TusharAMD
Copy link
Owner

Ok @aasthakourav20 assigned. but please don't remove the video link from the image. I would be uploading a video in few hours to get idea about project so start working on this issue after that.

@aasthakourav20
Copy link
Contributor Author

Ok @aasthakourav20 assigned. but please don't remove the video link from the image. I would be uploading a video in few hours to get idea about project so start working on this issue after that.

Sure !! Thank you

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

Successfully merging a pull request may close this issue.

2 participants