kreuzwerker / m1-terraform-provider-helper

CLI to support with downloading and compiling terraform providers for Mac with M1 chip
MIT License
491 stars 30 forks source link

Docs/clarify go dependency #135

Closed mbd-s closed 1 year ago

mbd-s commented 1 year ago

This PR hopefully resolves any ambiguity about satisfying the Go dependency for this tool, as brought up in #134. It also makes some other small edits to the docs and command descriptions.

What does this do / why do we need it?

Installing m1-terraform-provider-helper via Homebrew also installs Go as a dependency, but it doesn't ensure that the Go installation is working. Since a working Go configuration is a requirement for using the tool, this PR clarifies the nature of the dependency and how to satisfy it.

How this PR fixes the problem?

By adding a sub-section (Installation > Dependencies) to the README.

What should your reviewer look out for in this PR?

How clear is the proposed wording? Does it fit with the existing style? Is a version bump supposed to be included as well?

Check lists

Additional Comments (if any)

Please consider the two docs commits entirely optional. Here's what I did:

Which issue(s) does this PR fix?

fixes #134

Junkern commented 1 year ago

Thanks for the contribution! Will release a new patch version later today.