diff options
author | Jan Tattermusch <jtattermusch@google.com> | 2015-09-25 11:53:16 -0700 |
---|---|---|
committer | Jan Tattermusch <jtattermusch@google.com> | 2015-09-25 12:17:55 -0700 |
commit | 3fcbdef6f74be6071eac0b1e091611c0e6cd1bc4 (patch) | |
tree | 8aef5fecccca1491bafa04aaca06de078be6b6ee | |
parent | e0be467c3358f7dd06bf4208f9ae4f5970f138b8 (diff) |
further docs fixes
-rw-r--r-- | examples/csharp/helloworld/README.md | 46 | ||||
-rw-r--r-- | src/csharp/README.md | 22 |
2 files changed, 44 insertions, 24 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 diff --git a/src/csharp/README.md b/src/csharp/README.md index d091719ee5..b215d5aa07 100644 --- a/src/csharp/README.md +++ b/src/csharp/README.md @@ -24,7 +24,7 @@ HOW TO USE - Add NuGet package `Grpc` as a dependency (Project options -> Manage NuGet Packages). That will also pull all the transitive dependencies (including the native libraries that - gRPC C# is internally using). + gRPC C# is using internally). **Linux (Debian)** @@ -48,7 +48,7 @@ HOW TO USE and install it using `dpkg`. ```sh - # choose version corresponding to libgrpc you've installed. + # choose version corresponding to the version of libgrpc you've installed. wget https://github.com/grpc/grpc/releases/download/release-0_11_0/libgrpc-csharp-ext0_0.11.0.0-1_amd64.deb dpkg -i libgrpc-csharp-ext0_0.11.0.0-1_amd64.deb ``` @@ -64,9 +64,15 @@ HOW TO USE with Xamarin Studio on MacOS will not be great, as you won't be able to run your code directly from Xamarin Studio (which requires 32bit version of Mono). -- Install Homebrew and gRPC C Core using instructions in https://github.com/grpc/homebrew-grpc +- Install [homebrew][]. Run the following command to install gRPC C# native dependencies. -- Install 64-bit version of mono with command `brew install mono` (assumes you've already installed Homebrew). + ```sh + $ curl -fsSL https://goo.gl/getgrpc | bash - + ``` + This will download and run the [gRPC install script][], then install the latest version of gRPC C core and native C# extension. + It also installs Protocol Buffers compiler (_protoc_) and the gRPC _protoc_ plugin for ruby. + +- Install 64-bit version of mono with command `brew install mono`. - Open Xamarin Studio and start a new project/solution. @@ -146,7 +152,7 @@ tools/run_tests/run_tests.py -l csharp DOCUMENTATION ------------- - the gRPC C# reference documentation is available online at [grpc.io][] -- Helloworld project example can be found in https://github.com/grpc/grpc/tree/master/examples/csharp/helloworld. +- [Helloworld example][] CONTENTS -------- @@ -185,3 +191,9 @@ Internally, gRPC C# uses a native library written in C (gRPC C core) and invokes Installation on a machine where your application is going to be deployed is no different. - Possible cause for the problem is that the `grpc_csharp_ext` library is installed, but it has different bitness (32/64bit) than your C# runtime (in case you are using mono) or C# application. + +[homebrew]:http://brew.sh +[gRPC install script]:https://raw.githubusercontent.com/grpc/homebrew-grpc/master/scripts/install +[grpc.io]: http://www.grpc.io/docs/installation/csharp.html +[Debian jessie-backports]:http://backports.debian.org/Instructions/ +[Helloworld example]:../../examples/csharp/helloworld
\ No newline at end of file |