Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Go install instructions #23

Open
GWevroy opened this issue Mar 27, 2022 · 1 comment
Open

Update Go install instructions #23

GWevroy opened this issue Mar 27, 2022 · 1 comment

Comments

@GWevroy
Copy link

GWevroy commented Mar 27, 2022

Hi,
Hopefully I am making this request in the right place. Recently a colleague and I were struggling to get Periph.io installed. We were using the "go get" command but as you are aware, how this works changed slightly as of version 1.17.x whereby it also modifies project mod files. Hence the current instructions will only work if you have an existing go project under development, and you are in that directory (and you are aware and happy with the fact that it is going to modify your mod files)

After some discussion on Slack, we found that the ideal means of installing the entire periph.io library is to use the go "install" method as follows:
go install periph.io/x/cmd/...@latest

this will install the latest version. As this was quite a runaround for us, I'm sure other people will be having the same issue. Having some up to date instructions will certainly help a developer (or newbie) to get started with a lot less frustration.

Thanks for a great IO library!

@maruel
Copy link
Member

maruel commented Mar 28, 2022

Hi! Can you make a PR? You can do it in the web by opening https://github.com/periph/website/blob/main/site/content/_index.md then pressing dot "." on your keyboard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants