Skip to content

Commit b8cd2cb

Browse files
authored
README: explain how to generate interfaces
1 parent 95bbfce commit b8cd2cb

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,14 @@ To change the default debugging behavior, Go's `ldflags` parameter can be used.
183183

184184
Check out `debug_on.go` for any other settings that can be changed.
185185

186+
### Generating interfaces
187+
188+
We generate interfaces such as `IGameState` from structs to make it easier to keep docs in synch over structs and interfaces.
189+
For this we use [@vburenin](https://github.com/vburenin)'s [`ifacemaker`](https://github.com/vburenin/ifacemaker) tool.
190+
You can install it via `GO111MODULE=off go get github.com/vburenin/ifacemaker`.
191+
192+
After adding it to your `PATH` you can use `go generate` to update interfaces.
193+
186194
### Generating protobuf code
187195

188196
Should you need to re-generate the protobuf generated code in the `msg` package, you will need the following tools:

0 commit comments

Comments
 (0)