autoreadme | Automatically create github README.md 's from Go source code

by jimmyfrasche Go Version: Current License: BSD-2-Clause

X-Ray Key Features Code Snippets Community Discussions Vulnerabilities Install Support

kandi X-RAY | autoreadme Summary

autoreadme is a Go library. autoreadme has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. You can download it from GitHub.

Automatically generate a github README.md for your Go project. If you do not have the go command on your system, you need to Install Go first. Automatically generate a github README.md for your Go project. autoreadme(1) creates a github-formatted README.md using the same format as godoc(1). It includes the package summary and generates badges for godoc.org for the complete documentation and for travis-ci, if there's a .travis.yml file in the directory. It also includes copy-pastable installation instructions using the go(1) tool.

Support

Quality

Security

License

Reuse

Support

autoreadme has a low active ecosystem.

It has 63 star(s) with 8 fork(s). There are 4 watchers for this library.

It had no major release in the last 6 months.

There are 1 open issues and 3 have been closed. On average issues are closed in 340 days. There are no pull requests.

It has a neutral sentiment in the developer community.

The latest version of autoreadme is current.

Quality

autoreadme has 0 bugs and 0 code smells.

Security

autoreadme has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

autoreadme code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

autoreadme is licensed under the BSD-2-Clause License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

autoreadme releases are not available. You will need to build from source code and install.

Installation instructions are not available. Examples and code snippets are available.

It has 477 lines of code, 19 functions and 3 files.

It has high code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed autoreadme and discovered the below as its top functions. This is intended to give you an instant insight into autoreadme implemented functionality, and help decide if they suit your requirements.

blocks returns a list of blocks .
Parse the templates
getDoc returns the documentation for the given directory .
handling returns a heading from line .
dirs returns a list of dirs .
getTemplate returns the default template for the given directory .
fmtDoc formats the given doc as a string .
unindent removes indentation from block .
importPath returns the absolute path of the given directory .
renderExamples returns a map of example names .

Get all kandi verified functions for this library.

autoreadme Key Features

No Key Features are available at this moment for autoreadme.

autoreadme Examples and Code Snippets

No Code Snippets are available at this moment for autoreadme.

Community Discussions

No Community Discussions are available at this moment for autoreadme.Refer to stack overflow page for discussions.

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install autoreadme

You can download it from GitHub.

Support

For any new features, suggestions and bugs create an issue on GitHub. If you have any questions check and ask questions on community page Stack Overflow .

Find more information at: