update README
This commit is contained in:
parent
40fe09ed63
commit
8bb8c14e8b
1 changed files with 25 additions and 14 deletions
29
README.md
29
README.md
|
|
@ -2,9 +2,10 @@
|
||||||
|
|
||||||
Minimalistic plugin for Go development in Neovim written in Lua.
|
Minimalistic plugin for Go development in Neovim written in Lua.
|
||||||
|
|
||||||
It's not an LSP tool, the main goal of this plugin add go tooling support in neovim
|
It's not an LSP tool, the main goal of this plugin add go tooling support in neovim.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
Pre-dependency: [go](https://github.com/golang/go) (tested on 1.17 and 1.18)
|
Pre-dependency: [go](https://github.com/golang/go) (tested on 1.17 and 1.18)
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
|
|
@ -20,18 +21,28 @@ use {
|
||||||
Also, run `TSInstall go` if install the `go` parser if not installed yet.
|
Also, run `TSInstall go` if install the `go` parser if not installed yet.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
1. Install requires go tools:
|
1. Install requires go tools:
|
||||||
```lua
|
|
||||||
require"gopher".install_deps()
|
```viml
|
||||||
|
:GoInstallDeps
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Modify struct tags by:
|
1. Modify struct tags:
|
||||||
`json` default tag for add & remove
|
By default be added/removed `json` tag, if not set.
|
||||||
|
|
||||||
```lua
|
```viml
|
||||||
require"gopher".tags_add("json") -- add json tag
|
:GoTagAdd json " For add json tag
|
||||||
require"gopher".tags_rm("json") -- remove json tag
|
:GoTagRm yaml " For remove yaml tag
|
||||||
```
|
```
|
||||||
|
|
||||||
## Thanks:
|
1. Run `go mod` command
|
||||||
|
|
||||||
|
```viml
|
||||||
|
:GoMod tidy " Runs `go mod tidy`
|
||||||
|
:GoMod init asdf " Runs `go mod init asdf`
|
||||||
|
```
|
||||||
|
|
||||||
|
## Thanks
|
||||||
|
|
||||||
- [go.nvim](https://github.com/ray-x/go.nvim)
|
- [go.nvim](https://github.com/ray-x/go.nvim)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue