docs: adjust installation section #521
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
theoludwig
reviewed
Dec 15, 2025
Member
theoludwig
left a comment
There was a problem hiding this comment.
Nice, it's better that way. 👍
Should we also, include the Docker section, in here? It might make more sense, so that all the installation methods are at the same place?
Should we also link to https://github.com/editorconfig-checker/action-editorconfig-checker and https://github.com/editorconfig-checker/editorconfig-checker.javascript, https://github.com/editorconfig-checker/editorconfig-checker.python, etc?
a8016d6 to
27a39b6
Compare
theoludwig
approved these changes
Dec 15, 2025
Member
Author
|
@editorconfig-checker/core can I get another pair of eyes? |
ccoVeille
approved these changes
Dec 17, 2025
README.md
Outdated
Comment on lines
79
to
97
| ### 2. Using Go | ||
|
|
||
| If you have Go installed: | ||
|
|
||
| - Run: | ||
|
|
||
| `go get github.com/editorconfig-checker/editorconfig-checker/v3` <!-- x-release-please-major --> | ||
|
|
||
| - Then build the binary: | ||
| ```shell | ||
| make build | ||
| ``` | ||
| - The binary will be placed in the `bin` directory as `ec`. | ||
|
|
||
| Alternatively, with Go 1.16+ you can install globally: | ||
|
|
||
| ```shell | ||
| mise use -g editorconfig-checker@latest | ||
| go install github.com/editorconfig-checker/editorconfig-checker/v3/cmd/editorconfig-checker@latest | ||
| ``` |
Contributor
There was a problem hiding this comment.
I would invert and make go install first. Go 1.16 is really old now
3ebf183 to
174df6c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've added nix and brew installation methods.
The list is ordered by: