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

[DOCS]: Lack of a proper README.md file #1

Open
debarshee2004 opened this issue Jan 2, 2024 · 0 comments
Open

[DOCS]: Lack of a proper README.md file #1

debarshee2004 opened this issue Jan 2, 2024 · 0 comments

Comments

@debarshee2004
Copy link

Issue Summary

I noticed that the repository VIBE-n currently lacks a README.md file. A README file is crucial for providing essential information about the project, its purpose, and how to get started with it. Having a well-documented README.md file is not only helpful for contributors but also for users who come across the repository.

Solution

Writing a proper README.md file which would include:

  • Information about the Project
  • Basic understanding on how it works
  • How to setup the project

I @debarshee2004 would like to take the responsibility of this ISSUE.
Thank 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

No branches or pull requests

1 participant