dfe7d6eca119ac58be04a2ef1bf142c3e78b6c1a
- Author
- Bjorn Stange <bjorn248@gmail.com>
- Committer
- Marc Cornellà <marc.cornella@live.com>
- Date
Message
golang: add README (#7207)
Diff
1diff --git a/plugins/golang/README.md b/plugins/golang/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..72845b2a171bb631fa85beb665a35838633681b6
4--- /dev/null
5+++ b/plugins/golang/README.md
6@@ -0,0 +1,29 @@
7+# Golang plugin
8+
9+This plugin adds completion for the [Go Programming Language](https://golang.org/),
10+as well as some aliases for common Golang commands.
11+
12+To use it, add `golang` to the plugins array in your zshrc file:
13+
14+```zsh
15+plugins=(... golang)
16+```
17+
18+## Aliases
19+
20+| Alias | Command | Description |
21+| ------- | ----------------------- | ------------------------------------------------------------- |
22+| gob | `go build` | Build your code |
23+| goc | `go clean` | Removes object files from package source directories |
24+| god | `go doc` | Prints documentation comments |
25+| gof | `go fmt` | Gofmt formats (aligns and indents) Go programs. |
26+| gofa | `go fmt ./...` | Run go fmt for all packages in current directory, recursively |
27+| gog | `go get` | Downloads packages and then installs them to $GOPATH |
28+| goi | `go install` | Compiles and installs packages to $GOPATH |
29+| gol | `go list` | Lists Go packages |
30+| gop | `cd $GOPATH` | Takes you to $GOPATH |
31+| gopb | `cd $GOPATH/bin` | Takes you to $GOPATH/bin |
32+| gops | `cd $GOPATH/src` | Takes you to $GOPATH/src |
33+| gor | `go run` | Compiles and runs your code |
34+| got | `go test` | Runs tests |
35+| gov | `go vet` | Vet examines Go source code and reports suspicious constructs |