goethe

v0.0.3 | September 26, 2018

Generate a github flavored README.md file from a Go module.

Goethe parses your module directory for license, installation and command data, and generates a README.md file.

It is very unstable right now.

Go1.11 modules are required, and this version only scans for a Cobra Command for documentation.

Future versions will support godoc, other command line helpers, and distribution and deployment tools. It will hopefully save time for both the reader and writer of open source code.

Install

go get -u github.com/heindl/goethe

Command-line

goethe [go_module_path]

-p, --print   Print the template data to standard out.

Copyright 2018 Parker Heindl. All rights reserved. Use of this source code is governed by the MIT License.