Skip to content

README Question about Local Installation #377

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

Closed
Zamiell opened this issue Jan 25, 2019 · 2 comments
Closed

README Question about Local Installation #377

Zamiell opened this issue Jan 25, 2019 · 2 comments

Comments

@Zamiell
Copy link
Contributor

Zamiell commented Jan 25, 2019

Greetings golangci-lint maintainers. Thanks again for the excellent (and free!) software. I recently submitted a pull request to update the README file, but since then it has changed again and I had a question.

In this commit:
2192097

@jirfag changed:

(On Windows, you can run the above commands with Git Bash, which comes with [Git for Windows](https://git-scm.com/download/win).

to:

(On Windows, you can run the above commands with Git Bash, which comes with [Git for Windows](https://git-scm.com/download/win). Or you can run just `go get -u github.com/golangci/golangci-lint/cmd/golangci-lint`.)

As a nooby non-technical end-user, this is confusing. Are the lines:

cd $(go env GOPATH)/src/github.com/golangci/golangci-lint/cmd/golangci-lint
go install -ldflags "-X 'main.version=$(git describe --tags)' -X 'main.commit=$(git rev-parse --short HEAD)' -X 'main.date=$(date)'"

necessary? Or are they not necessary? What do they even do? If they are not necessary, can they be removed from the README entirely to simplify it? If they are necessary, can this please be added to the README file to document exactly what they do? Perhaps with an inline comment? If they are necessary, why exactly can Windows users skip it? If Windows users do skip it, what are the implications? And so on.

Thanks.

@Zamiell Zamiell changed the title README Question README Question about Local Installation Jan 25, 2019
@jirfag
Copy link
Contributor

jirfag commented Jan 26, 2019

hi, thank you!

I've tried to simplify docs. Check it please in README

@Zamiell
Copy link
Contributor Author

Zamiell commented Jan 26, 2019

Thank you, that explains it!

@Zamiell Zamiell closed this as completed Jan 26, 2019
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

No branches or pull requests

2 participants