Verified Commit 160ad1d2 authored by Marco Kellershoff's avatar Marco Kellershoff 🤸
Browse files

First working README version

parent 237b61f0
# superevil-golint
# Super Evil Golang Linter
A super evil linter for Golang.
## Requirements
- Linux or MacOS
- [Golang][golang]
## Installation
Install using one of the following locations:
- https://git.superevilmegaco.com/golang/superevil-golint
- https://github.com/stroeerdigitalpublishing/superevil-golint
- https://github.com/superevilmegaco/superevil-golint
## Usage
Switch to the root of your project directory and run the following command
```bash
go lint
```
## Passing checks
To pass the *linting* rules, your code has to pass the following checks:
- [gofmt][gofmt]
- [golint][golint]
- have at least 90% code coverage
## Dependencies
These dependencies are automatically resolved when you install the
*Super Evil Golang Linter*.
- [gofmt][gofmt]
- [gomega][gomega]
- [goblin][goblin]
- [golint][golint]
[gofmt]: https://golang.org/cmd/gofmt/
[gomega]: https://github.com/onsi/gomega
[goblin]: https://github.com/franela/goblin
[golint]: https://godoc.org/golang.org/x/lint/golint
[golang]: https://golang.org/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment