Skip to content
This repository has been archived by the owner on Jul 5, 2024. It is now read-only.

📚 Add installation instructions to README #5

Merged
merged 2 commits into from
Mar 13, 2020
Merged

📚 Add installation instructions to README #5

merged 2 commits into from
Mar 13, 2020

Conversation

goodevilgenius
Copy link
Contributor

Since not everyone is familiar with go, it would be useful to include installation instructions.

The mention of the version of go was added because using an older version (such as the default version that comes with the most recent Linux Mint) results in the error

# github.com/alexzorin/authy/cmd/authy-export
go/src/github.com/alexzorin/authy/cmd/authy-export/authy-export.go:237:19: undefined: os.UserHomeDir

@alexzorin
Copy link
Owner

alexzorin commented Mar 13, 2020

Thanks, I definitely agree that it's a good idea to add some installation instructions.

What is not obvious at the moment is that you can download pre-built binaries for Linux, Windows and macOS from https://github.com/alexzorin/authy/releases . These don't require installation or any knowledge of Go. But the link is hard to find in the GitHub UI.

I would prefer if the README pointed to that page as the primary installation method.

Adding those "easy" instructions also means we don't have to be so hand-holding about the Go instructions, so maybe they can be reduced to something like:


Alternatively, you can compile it from source yourself, which requires Go 1.12 or newer:

go get github.com/alexzorin/authy/cmd/authy-export

@alexzorin alexzorin merged commit 0b20237 into alexzorin:master Mar 13, 2020
@goodevilgenius goodevilgenius deleted the patch-1 branch March 13, 2020 21:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants