goethe

command module

v0.0.4 Latest Latest Go to latest Published: Sep 26, 2018 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/heindl/goethe

Links

Open Source Insights

README ¶

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.

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
cmd Package cmd contains embedded resources	Package cmd contains embedded resources
parsers
cobra Package cobra contains embedded resources	Package cobra contains embedded resources
cobra/test_data/pkg_compile_test
cobra/test_data/pkg_search_test
cobra/test_data/pkg_search_test/pkg_search_inner_test
render
sections
cmdline Package cmdline contains embedded resources	Package cmdline contains embedded resources
header Package header contains embedded resources	Package header contains embedded resources
install Package install contains embedded resources	Package install contains embedded resources
license
utilities

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL