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

Improve README #1

Closed
BurhanRaja opened this issue Feb 8, 2023 · 6 comments
Closed

Improve README #1

BurhanRaja opened this issue Feb 8, 2023 · 6 comments

Comments

@BurhanRaja
Copy link

Make a documentation more user friendly.

Write Intructions to use the project.
Add tech stack you used.
Add Images or Demo Video of your project.
Also define File structure.
Add description. In that, you can had why you build the project, what is your learning outcome and what problems did you face.

@BurhanRaja BurhanRaja changed the title Improve Documentation Improve README Feb 8, 2023
@BurhanRaja
Copy link
Author

Assign the issue to me I will help you.

@AbhayKadam57
Copy link
Owner

@BurhanRaja, Thank you for reviewing the repo and offering help, I appreciate it, I am currently working on revised documentation. Also, I am considering your points in the revised readme documentation. I will publish it soon. If I find difficulty I will definitely approach you.

@AbhayKadam57
Copy link
Owner

@BurhanRaja, Hi, Please check, I revised and try to improve the README.md file. Kindly review and suggest any further changes.

1 similar comment
@AbhayKadam57
Copy link
Owner

@BurhanRaja, Hi, Please check, I revised and try to improve the README.md file. Kindly review and suggest any further changes.

@BurhanRaja
Copy link
Author

BurhanRaja commented Feb 9, 2023

@BurhanRaja, Hi, Please check, I revised and try to improve the README.md file. Kindly review and suggest any further changes.

Great! Its looking good. If a new developer comes to look at your project it looks good and they understand the project easily.

@AbhayKadam57
Copy link
Owner

AbhayKadam57 commented Feb 9, 2023

@BurhanRaja, Thank you so much for reviewing and suggesting. I am closing the issue now If you find any other issues in this repo. Please suggest.

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