godoc2readme

command module

v0.0.0-...-d4140e1 Latest Latest Go to latest Published: May 8, 2019 License: BSD-3-Clause Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

godoc2readme converts godoc formatted package documentation into Markdown format that can be used directly as github README.md.

Usage

godoc2readme github.com/sunfmin/godoc2readme > README.md

# godoc to README.md godoc2readme converts godoc formatted package documentation into Markdown format that can be used directly as github README.md.

Usage

godoc2readme github.com/sunfmin/godoc2readme > README.md