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

docs: 📝 update instructions for source installation #585

Merged
merged 5 commits into from
Jun 30, 2024
Merged

docs: 📝 update instructions for source installation #585

merged 5 commits into from
Jun 30, 2024

Conversation

minhtrancccp
Copy link
Contributor

@minhtrancccp minhtrancccp commented Jun 29, 2024

as i tried to check for the fix to the erroneous failed to read config file message (as shown in #488), i first executed go install github.com/noborus/ov@latest, which just fetched the latest release build and did not included the fix (i wasn't aware of how to install from the master branch at the time). when i followed the option of go get -d github.com/noborus/ov, i got an error from go itself, saying:

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'.

i assume that those without much knowledge of go like myself but want to have a local clone of the repo would be confused by this error message, which can be easily resolved by cloning the repo directly with git clone or gh repo clone instead, hence the reason why this commit was made.

replace instructions using deprecated `go get -d` command with `git clone` to fetch repo and build locally
modify the `cd` command in example so as to notify users which directory to jump into
Include an option to build the excutable from `master` branch with `go install`
@noborus
Copy link
Owner

noborus commented Jun 30, 2024

Thanks for your pull request.
Documentation improvements are welcome.

README.md Outdated Show resolved Hide resolved
@noborus
Copy link
Owner

noborus commented Jun 30, 2024

Thank you for the correction.
I think it's good so I'll merge it.
Please feel free to give your feedback anytime.

@noborus noborus merged commit 5fbd254 into noborus:master Jun 30, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants