add git and golang for windows, fix some PATH stuff

[webi-installers/.git] / vim-go / README.md

diff --git a/vim-go/README.md b/vim-go/README.md
new file mode 100644 (file)
index 0000000..ebabbd2
--- /dev/null
+++ b/vim-go/README.md
@@ -0,0 +1,71 @@
+---
+title: vim-go
+homepage: https://github.com/fatih/vim-go
+tagline: |
+  vim-go adds Go language support for Vim.
+description: |
+  `vim-go` provides integration with various official and 3rd part go tooling for linting, vetting, etc.
+
+  You'll also need `syntastic` or similar.
+---
+
+### How to install by hand
+
+```bash
+git clone --depth=1 https://github.com/fatih/vim-go.git ~/.vim/pack/plugins/start/vim-go
+```
+
+### How to configure your `.vimrc`
+
+```vimrc
+" don't check syntax immediately on open or on quit
+let g:syntastic_check_on_open = 1
+let g:syntastic_check_on_wq = 0
+
+" we also want to get rid of accidental trailing whitespace on save
+autocmd BufWritePre * :%s/\s\+$//e
+```
+
+```vimrc
+"""""""""""""""""""""""""""
+" Golang-specific options "
+"""""""""""""""""""""""""""
+
+" tell syntastic that go, golint, and errcheck are installed
+let g:syntastic_go_checkers = ['go', 'golint', 'errcheck']
+
+" tell vim-go that goimports is installed
+let g:go_fmt_command = "goimports"
+
+" tell vim-go to highlight
+let g:go_highlight_functions = 1
+let g:go_highlight_methods = 1
+let g:go_highlight_structs = 1
+let g:go_highlight_operators = 1
+let g:go_highlight_build_constraints = 1
+```
+
+### How to install go language tools
+
+```bash
+# gopls
+go get golang.org/x/tools/gopls
+
+# golint
+go get golang.org/x/lint/golint
+
+# errcheck
+go get github.com/kisielk/errcheck
+
+# gotags
+go get github.com/jstemmer/gotags
+
+# goimports
+go get golang.org/x/tools/cmd/goimports
+
+# gorename
+go get golang.org/x/tools/cmd/gorename
+
+# gotype
+go get golang.org/x/tools/cmd/gotype
+```