Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
x/build: flesh out READMEs #21285
So, do that. And also go through each README.md and add useful content if warranted.
And/or look at @davecheney's https://github.com/davecheney/godoc2md and maybe use that too, to put more of the package doc into the Markdown. I was only able to get the synopsis easily, but it'd be nice to have the whole package comment.
(I don't need to see the API, though. That's what godoc.org is for.)
You can use
See https://godoc.org/go/doc#Package.Doc, that's the whole package comment, not just synopsis.
(Edit: If you need help going from