Discussion on "The Unsung Hero of Projects: The README File"

Scott Wright · 2024-02-03T11:13:29.146Z

It’s a popular recommendation when starting to code to document your journey. It allows us to showcase not only what we’ve been working on but also the progression and skills we've acquired along the way. However, an aspect often overlooked is the im...

Well put! Bland/no README is definitely an off-putter for me while checking out a project on GitHub (I mean, why open source what someone can't understand it's purpose at a glance?. My key takeaway from your README template is the TOC 😅. I pretty much do everything else in yours already (check out my latest project on GitHub: HashBot). Do you come up with the header IDs yourself? If yes, how do you handle emojis in headers? Thanks.

PS: I tried playing your Battleship game but couldn't figure out how it works ;(.

Don't mention it Scott Wright ✌🏽.

Regarding the emojis, I meant like on a project README. From my quick "research", I found out that GitHub auto-generates a TOC & removes emojis from the ID. It's an easy-to-miss feature, so having your own TOC is best for now.

Just seeing profileme.dev for the first time. Cool stuff! Thanks for the recommendation.

Lastly, the only issue I had with Battleship was I didn't know how to play it ;). No instructions. I think that's similar to not having a README in a repo yeah 😅?

Omezibe Obioha You make a good point 😅! I should add some instructions to the repo, thats really helpful feedback so I'm definitely going to add them. Really appreciate that!

Scott Wright Haha, you're welcome 😁

Search Hashnode

The Unsung Hero of Projects: The README File

Responses1