Skip to content

Suggest go tool usage in Quickstart #448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philhofer merged 1 commit into from
Aug 27, 2026
+3 −3
Merged

Suggest go tool usage in Quickstart #448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ This is a code generation tool and serialization library for [MessagePack](http:

### Quickstart

First install the `msgp` generator command. Using Go this is done with `go install github.com/tinylib/msgp@latest`
First add `msgp` generator command as a go tool. Using Go this is done with `go mod edit -tool=github.com/tinylib/msgp&&go mod tidy`

In a source file, include the following directive:

```go
//go:generate msgp
//go:generate go tool msgp
```

The `msgp` command will generate serialization methods for all exported type declarations in the file.
The `go tool msgp` command will generate serialization methods for all exported type declarations in the file.

You can [read more about the code generation options here](http://github.com/tinylib/msgp/wiki/Using-the-Code-Generator).

Expand Down
Loading