Skip to content

Commit 3b42f6f

Browse files
committed
mention build tools
1 parent 393ea28 commit 3b42f6f

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/gettingstarted.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,13 @@ by having an up-to-date IDE. Note that the tools work on more platforms than jus
3737

3838
Also: make sure that you are *actually using* the correct .NET Core SDK (usually via "global.json").
3939

40+
Note: to avoid common usage errors with protobuf-net and gRPC, consider using [`protobuf-net.BuildTools`](https://protobuf-net.github.io/protobuf-net/build_tools), which
41+
reports problems at build-time.
42+
4043
### 1: define your data contracts and service contracts
4144

4245
Your service and data contracts can be placed directly in the client/server (see later), or can be in a separate class library. If you use
43-
a separate library, make sure you target `netcoreapp3.0`.
46+
a separate library, make sure you target `netcoreapp3.0` or above.
4447

4548
As for what they look like: think "WCF". Data contracts are classes marked with either `[ProtoContract]` or `[DataContract]`, with individual members
4649
annotated with either `[ProtoMember]` or `[DataMember]`. The `[Proto*]` options are protobuf-net specific and offer fine-grained

readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ It should work on all .NET languages that can generate something *even remotely
88

99
- [Getting Started](https://protobuf-net.github.io/protobuf-net.Grpc/gettingstarted)
1010
- [All Documentation](https://protobuf-net.github.io/protobuf-net.Grpc/)
11+
- [Build/usage available via `protobuf-net.BuildTools`](https://protobuf-net.github.io/protobuf-net/build_tools)
1112

1213
Usage is as simple as declaring an interface for your service-contract:
1314

0 commit comments

Comments
 (0)