Install GodocGen

Godocgen has a number of ways to install as a program in your operating system. Let's look at these supported methods.

Go Get

To install via go get, you simply do go get against a release branch version:

$ go get gitlab.com/zoralab/godocgen/cmd/godocgen@releases-VERSION

This will install the binary automatically inside your $GOBIN (or $GOPATH/bin path).

NOTE: we decided to use branching over tagging mainly because the current Go Get enforces version folder implementation.

This enforcement is enough to create messed up code base, unnecessary codes duplications, and complicated the user guides (inconsistent patterns). Hence, It is better to use protective branches instead.

Supported Versions

These are the supported Go Get versions:

$ go get gitlab.com/zoralab/godocgen/cmd/godocgen@releases-v0.0.2
$ go get gitlab.com/zoralab/godocgen/cmd/godocgen@releases-v0.0.1

DEB Package (Coming Soon)

The DEB package server hosting is planned and will be supported soon.

RPM Package (Coming Soon)

The RPM package server hosting is planned and will be supported soon.

What's Next?

Now that you have installed Godocgen into your operating system, we can now proceed to the learn how to use it:

NEXT: Using Godocgen