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

Write a Readme for the project #9

Closed
anupammaurya6767 opened this issue May 7, 2024 · 7 comments · Fixed by #78
Closed

Write a Readme for the project #9

anupammaurya6767 opened this issue May 7, 2024 · 7 comments · Fixed by #78
Assignees

Comments

@anupammaurya6767
Copy link
Owner

Is your feature request related to a problem? Please describe.
The project currently lacks a comprehensive Readme file, which is essential for new contributors to understand the project and how to set it up locally.

Describe the solution you'd like
Create a Readme.md file that provides an overview of the project, including its purpose, features, setup instructions, configuration, and usage guidelines.

Describe alternatives you've considered
An alternative could be creating separate documents for specific sections of the Readme, but a single comprehensive Readme.md file would be more user-friendly.

Additional context
Adding a Readme.md file will improve the project's documentation and make it easier for contributors to get started with the project.

@yashisrani
Copy link

@anupammaurya6767 kindly assign me this issue under #gssoc'24 .. I will Enhance Readme file and make it beautiful , clear and usable for other folks ..

@anupammaurya6767
Copy link
Owner Author

@yashisrani go ahead

@IP80808080
Copy link

👋 Hello! I'd be happy to help with this issue. Could you please assign it to me? Thank you! 🚀

@harini-1597
Copy link
Contributor

Hi. Noticed this issue is still not resolved as the README is still just two lines. Could you assign it to me? I'll have it done asap

@anupammaurya6767
Copy link
Owner Author

@harini-1597 go ahead

@harini-1597
Copy link
Contributor

How does this look?

Recording.2024-06-08.155444.mp4

@anupammaurya6767
Copy link
Owner Author

@harini-1597 nice create a pull request

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.

4 participants