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

[DOC]- Write a better Readme file #2

Open
gambhirsharma opened this issue May 7, 2023 · 3 comments
Open

[DOC]- Write a better Readme file #2

gambhirsharma opened this issue May 7, 2023 · 3 comments

Comments

@gambhirsharma
Copy link

While going through the project it was very difficult for me to navigate through the project. The main reason for this inconvenience is due to not using heading and code plates in the required region.

So, I suggest you, add some heading sections and code-plates in the documentation. And, if you want I can work on this issue. :)

@adityaravi9034
Copy link
Owner

Feel free to do so.

@gambhirsharma
Copy link
Author

@adityaravi9034 can you provide a demo file that we can include in the readme file to check that the code is working properly in the local system?

@adityaravi9034
Copy link
Owner

Sorry I was quite occupied with other stuff in school, therefore I closed the issue for a while

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

2 participants