blob: 63131ed98c0004ff464c36e91a1549318890e557 [file] [log] [blame] [view]
Jan Tattermusch226af652015-04-03 16:39:51 -07001gRPC in 3 minutes (C#)
2========================
3
4BACKGROUND
5-------------
Jan Tattermusch3fcbdef2015-09-25 11:53:16 -07006For this sample, we've already generated the server and client stubs from [helloworld.proto][].
7
8Example projects depend on the [Grpc](https://www.nuget.org/packages/Grpc/)
9and [Google.Protobuf](https://www.nuget.org/packages/Google.Protobuf/) NuGet packages
10which have been already added to the project for you.
Jan Tattermusch226af652015-04-03 16:39:51 -070011
12PREREQUISITES
13-------------
Jan Tattermusch2fca5452015-05-21 17:46:27 -070014**Windows**
Jan Tattermusch226af652015-04-03 16:39:51 -070015- .NET 4.5+
Jan Tattermusch3fcbdef2015-09-25 11:53:16 -070016- Visual Studio 2013 or 2015
Jan Tattermusch226af652015-04-03 16:39:51 -070017
Jan Tattermusch3fcbdef2015-09-25 11:53:16 -070018**Linux**
Jan Tattermusch7492c7c2016-02-12 15:25:45 -080019- Mono 4.0+
20- Monodevelop 5.9+ (with NuGet plugin installed)
Jan Tattermusch226af652015-04-03 16:39:51 -070021
Jan Tattermusch3fcbdef2015-09-25 11:53:16 -070022**Mac OS X**
Jan Tattermusch7492c7c2016-02-12 15:25:45 -080023- Xamarin Studio 5.9+
Jan Tattermusch3fcbdef2015-09-25 11:53:16 -070024- [homebrew][]
Jan Tattermusch226af652015-04-03 16:39:51 -070025
26BUILD
27-------
28
Jan Tattermusch7492c7c2016-02-12 15:25:45 -080029- Open solution `Greeter.sln` with Visual Studio, Monodevelop (on Linux) or Xamarin Studio (on Mac OS X)
Jan Tattermusch3fcbdef2015-09-25 11:53:16 -070030
31- Build the solution (this will automatically download NuGet dependencies)
32
33Try it!
Jan Tattermusch226af652015-04-03 16:39:51 -070034-------
35
36- Run the server
Jan Tattermusch2fca5452015-05-21 17:46:27 -070037
38 ```
39 > cd GreeterServer/bin/Debug
40 > GreeterServer.exe
41 ```
Jan Tattermusch226af652015-04-03 16:39:51 -070042
43- Run the client
Jan Tattermusch2fca5452015-05-21 17:46:27 -070044
45 ```
46 > cd GreeterClient/bin/Debug
47 > GreeterClient.exe
48 ```
Jan Tattermusch226af652015-04-03 16:39:51 -070049
Jan Tattermusch7492c7c2016-02-12 15:25:45 -080050You can also run the server and client directly from the IDE.
Jan Tattermusch226af652015-04-03 16:39:51 -070051
52On Linux or Mac, use `mono GreeterServer.exe` and `mono GreeterClient.exe` to run the server and client.
53
54Tutorial
55--------
56
Jan Tattermusch3fcbdef2015-09-25 11:53:16 -070057You can find a more detailed tutorial in [gRPC Basics: C#][]
58
59[homebrew]:http://brew.sh
60[helloworld.proto]:../../protos/helloworld.proto
Jan Tattermusch3fcbdef2015-09-25 11:53:16 -070061[gRPC Basics: C#]:http://www.grpc.io/docs/tutorials/basic/csharp.html