DEV Community

Discussion on: How to Create the Perfect README for Your Open Source Project

Collapse
 
michaelcurrin profile image
Michael Currin • Edited

Yes docs make a repo more professional and friendly, for other devs and for colleagues and potential employers.

I tried that tool before you recommended and found it needed too much manual changes for what I need.

I have this as a template across languages.

Docs directory

github.com/MichaelCurrin/generic-p...

Main README

github.com/MichaelCurrin/generic-p...


As a bonus, if you go from the repo main README you'll see a link to the docs site which is all markdown files and hosted with Jekyll and GH Pages.

Collapse
 
blackgirlbytes profile image
Rizèl Scarlett

Great share! The docs directory link is broken for me!

Collapse
 
michaelcurrin profile image
Michael Currin

Thanks. Fixed