keltia / dmarc-cat

Small utility to decode the report sent by various email providers following the DMARC spec
Other
62 stars 13 forks source link

Installation instructions in README are outdated? #18

Open guss77 opened 1 year ago

guss77 commented 1 year ago
~ $ go version
go version go1.19.2 linux/amd64

Following the install instructions from the README, I got this:

~ $ go get github.com/keltia/dmarc-cat
go: go.mod file not found in current directory or any parent directory.
        'go get' is no longer supported outside a module.
        To build and install a command, use 'go install' with a version,
        like 'go install example.com/cmd@latest'
        For more information, see https://golang.org/doc/go-get-install-deprecation
        or run 'go help get' or 'go help install'.

Then

~ $ go install github.com/keltia/dmarc-cat
go: 'go install' requires a version when current directory is not in a module
        Try 'go install github.com/keltia/dmarc-cat@latest' to install the latest version
~ $ go install github.com/keltia/dmarc-cat@latest
go: downloading github.com/keltia/dmarc-cat v0.15.0
go: downloading github.com/intel/tfortools v0.2.0
go: downloading github.com/keltia/archive v0.9.1
go: downloading github.com/pkg/errors v0.9.1
go: downloading github.com/stretchr/testify v1.3.0
go: downloading github.com/klauspost/compress v1.10.10
go: downloading github.com/proglottis/gpgme v0.1.1
go: downloading github.com/davecgh/go-spew v1.1.1
go: downloading github.com/pmezard/go-difflib v1.0.0
# github.com/proglottis/gpgme
.local/share/go/pkg/mod/github.com/proglottis/gpgme@v0.1.1/data.go:4:11: fatal error: gpgme.h: No such file or directory
    4 | // #include <gpgme.h>
      |           ^~~~~~~~~
compilation terminated.
~ $ sudo apt install libgpgme-dev
### ...
~ $ go install github.com/keltia/dmarc-cat@latest
~ $ dmarc-cat --version
dmarc-cat version 0.15.0,parallel/j8 archive/0.9.1

The missing gpgme dep is kind of on me - you did mention something about it in the README, but still - it could have been more explicit: even a just having "Dependencies" section with a list would have made me realize that I need to install something first.