Skip to content

Commit 8af08b7

Browse files
committed
chore: document api update process
1 parent 07a0b09 commit 8af08b7

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@
66

77
Neovim/go-client is a [Neovim](https://neovim.io/) client for [Go](https://golang.org/).
88

9+
Update API
10+
----------
11+
12+
The API can be updated with the api tool.
13+
14+
```sh
15+
cd nvim
16+
17+
# The compare command indicates what functions need to be changed. The results
18+
# should be added to `api_def.go`.
19+
go run api_tool.go -compare
20+
21+
# After applying the chages from compare to `api_def.go`, generate the `api.go`
22+
# and `api_deprecated.go` files.
23+
go generate
24+
```
25+
926
Release
1027
-------
1128

0 commit comments

Comments
 (0)