▲ 7 ▼ Tool to help generate better ReadMe files for Go packages
A small step-by-step procedure to generate a great ReadMe file for your GoLang package.
Register to comment or vote on this story
A small step-by-step procedure to generate a great ReadMe file for your GoLang package.
I love this! There's so many Go projects that barely have a description, let alone a usage example, in their README's. GoDoc's great but to get a feel for what a library does and how to get started browsing through that isn't that great of an experience.
Yes you can do this with GitHub when you set up a repo (they let you choose a license and a readme, but this tool guides you through making a really useful readme file with all the sections you'd need. Will definitely be checking it out.