lib

Documentation

Index

• func GetLongDesc(path string) string
• func GetShortDesc(path string) string
• func GetToolName(path string) string
• func GetVersion() string

Functions

func GetLongDesc

func GetLongDesc(path string) string

Fetch long description from the specified path.

Expects a README.md with the simple formatting of a h1 and then plaintext for the long description.

func GetShortDesc

func GetShortDesc(path string) string

Fetch short description from the specified path

Expects a README.md with the same formatting as LongDesc but parses only the first non header line as the ShortDesc

func GetToolName

func GetToolName(path string) string

Fetch tool name from the specified path

Expects a README.md with the name of the tool as a markdown h1 for the first line

func GetVersion

func GetVersion() string

Parse version number from the version file