README query #412
Replies: 2 comments
-
I am writing notes on this at the moment, so I will give a short answer now, and another more full answer later. My thoughts are, this is the first impression someone gets of your repo, so the first page of the README needs to easily show what the project is about and what it looks like.
|
Beta Was this translation helpful? Give feedback.
-
I agree with all the points made by @eddiejaoude 😃. I'd add architecture diagrams (screenshots or perhaps a link to more docs on this) and a roadmap of the project (in case it fits the use case). Might be worth checking this out @kruthikahm2000: https://github.com/matiassingers/awesome-readme |
Beta Was this translation helpful? Give feedback.
-
How to built a README most creative and best(from basics to advance)?!
Beta Was this translation helpful? Give feedback.
All reactions