diff options
| author | Oskari Timperi <oskari.timperi@iki.fi> | 2018-04-11 22:17:00 +0300 |
|---|---|---|
| committer | Oskari Timperi <oskari.timperi@iki.fi> | 2018-04-11 22:17:00 +0300 |
| commit | 7998561bd90232d730ac3d9c85c6a46ca1d0f170 (patch) | |
| tree | c7e0c9421880815405feb0623acafc3e32b8ed29 | |
| parent | a829d59fb2cdb5c3362729e23da4f35f9558cb35 (diff) | |
| download | nimpb-7998561bd90232d730ac3d9c85c6a46ca1d0f170.tar.gz nimpb-7998561bd90232d730ac3d9c85c6a46ca1d0f170.zip | |
Update README.md
| -rw-r--r-- | README.md | 7 |
1 files changed, 5 insertions, 2 deletions
@@ -2,7 +2,10 @@ A Nim library to serialize/deserialize Protocol Buffers. -For generating Nim code usable with nimpb, you should use [nimpb_build](https://github.com/oswjk/nimpb-build). +To actually generate Nim code from protobuf definitions, you need the protoc +tool. To make things simple, nimpb depends on +[nimpb_protoc](https://github.com/oswjk/nimpb_protoc), which bundles protoc +binaries for the most common platforms (Windows, Linux, macOS). **NOTE** At the moment this is at a very rough state. Do not use for any kind of production use. Anything can change at any time. You've been warned. @@ -25,7 +28,7 @@ message Test1 { } ``` -You can use [nimpb_build](https://github.com/oswjk/nimpb-build) to generate code like this (procs not included in the example): +You can use nimpb_build (a tool that comes with nimpb) to generate code like this (procs not included in the example): ```nim type |
