aboutsummaryrefslogtreecommitdiffhomepage
path: root/examples/csharp
diff options
context:
space:
mode:
authorGravatar Jan Tattermusch <jtattermusch@google.com>2015-09-25 11:53:16 -0700
committerGravatar Jan Tattermusch <jtattermusch@google.com>2015-09-25 12:17:55 -0700
commit3fcbdef6f74be6071eac0b1e091611c0e6cd1bc4 (patch)
tree8aef5fecccca1491bafa04aaca06de078be6b6ee /examples/csharp
parente0be467c3358f7dd06bf4208f9ae4f5970f138b8 (diff)
further docs fixes
Diffstat (limited to 'examples/csharp')
-rw-r--r--examples/csharp/helloworld/README.md46
1 files changed, 27 insertions, 19 deletions
diff --git a/examples/csharp/helloworld/README.md b/examples/csharp/helloworld/README.md
index 3719080f4a..f1af1f6793 100644
--- a/examples/csharp/helloworld/README.md
+++ b/examples/csharp/helloworld/README.md
@@ -3,49 +3,52 @@ gRPC in 3 minutes (C#)
BACKGROUND
-------------
-For this sample, we've already generated the server and client stubs from `helloworld.proto`.
-Example projects depend on NuGet packages `Grpc` and `Google.ProtocolBuffers` which have been already added to the project for you.
+For this sample, we've already generated the server and client stubs from [helloworld.proto][].
+
+Example projects depend on the [Grpc](https://www.nuget.org/packages/Grpc/)
+and [Google.Protobuf](https://www.nuget.org/packages/Google.Protobuf/) NuGet packages
+which have been already added to the project for you.
PREREQUISITES
-------------
**Windows**
- .NET 4.5+
-- VS 2013 (with NuGet plugin installed)
+- Visual Studio 2013 or 2015
-**Linux (Mono)**
+**Linux**
- Mono
-- Monodevelop 5.9 with NuGet Add-in installed (older versions might work)
+- Monodevelop 5.9 with NuGet Add-in installed
-**MacOS (Mono)**
+**Mac OS X**
- Xamarin Studio (with NuGet plugin installed)
+- [homebrew][]
BUILD
-------
**Windows**
-- Clone this repository.
- Open solution `Greeter.sln` with Visual Studio
- Build the solution (this will automatically download NuGet dependencies)
-**Linux (Mono)**
-- Clone this repository.
+**Linux (Debian)**
+
+- Install gRPC C core and C# native extension using [How to use gRPC C#][] instructions
-- Install gRPC C Core using instructions in https://github.com/grpc/homebrew-grpc
+- Open solution `Greeter.sln` in MonoDevelop.
-- gRPC C# depends on native shared library `libgrpc_csharp_ext.so`. To make it visible
- to Mono runtime, follow instructions in [Using gRPC C# on Linux](https://github.com/grpc/grpc/tree/master/src/csharp#usage-linux-mono)
+- Build the solution (you need to manually restore dependencies by using `mono nuget.exe restore` if you don't have NuGet add-in)
-- Open solution `Greeter.sln` in MonoDevelop (you need to manually restore dependencies by using `mono nuget.exe restore` if you don't have NuGet add-in)
+**Mac OS X**
-- Build the solution.
+- Install gRPC C core and C# native extension using [How to use gRPC C#][] instructions
-**MacOS (Mono)**
-- See [Using gRPC C# on MacOS](https://github.com/grpc/grpc/tree/master/src/csharp#usage-macos-mono) for more info
- on MacOS support.
+- Open solution `Greeter.sln` with Xamarin Studio
-Try it!
+- Build the solution (this will automatically download NuGet dependencies)
+
+Try it!
-------
- Run the server
@@ -69,4 +72,9 @@ On Linux or Mac, use `mono GreeterServer.exe` and `mono GreeterClient.exe` to ru
Tutorial
--------
-You can find a more detailed tutorial in [gRPC Basics: C#](route_guide/README.md)
+You can find a more detailed tutorial in [gRPC Basics: C#][]
+
+[homebrew]:http://brew.sh
+[helloworld.proto]:../../protos/helloworld.proto
+[How to use gRPC C#]:../../../src/csharp#how-to-use
+[gRPC Basics: C#]:http://www.grpc.io/docs/tutorials/basic/csharp.html