Skip to content

Commit

Permalink
update the README files
Browse files Browse the repository at this point in the history
  • Loading branch information
jtattermusch committed Jul 26, 2018
1 parent 9f3e83e commit 1a70151
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
13 changes: 6 additions & 7 deletions examples/csharp/Helloworld/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ gRPC in 3 minutes (C#)

BACKGROUND
-------------
This is a different version of the helloworld example, using the dotnet sdk
tools to build and run.

For this sample, we've already generated the server and client stubs from [helloworld.proto][].

Example projects in this directory depend on the [Grpc](https://www.nuget.org/packages/Grpc/)
Expand All @@ -15,17 +12,19 @@ which have been already added to the project for you.
PREREQUISITES
-------------

- The [.NET Core SDK](https://www.microsoft.com/net/core).
- The [.NET Core SDK](https://www.microsoft.com/net/core) (version 2+ is recommended)

You can also build the example directly using Visual Studio 2017, but it's not a requirement.

BUILD
-------

From the `examples/csharp/helloworld-from-cli` directory:

- `dotnet restore Greeter.sln`
From the `examples/csharp/Helloworld` directory:

- `dotnet build Greeter.sln`

(if you're using dotnet SDK 1.x you need to run `dotnet restore Greeter.sln` first)

Try it!
-------

Expand Down
8 changes: 6 additions & 2 deletions examples/csharp/HelloworldLegacyCsproj/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ gRPC in 3 minutes (C#)

BACKGROUND
-------------
This is a different version of the helloworld example, using the old-style .csproj
files supported by VS2013 and VS2015 (and older versions of mono).
You can still use gRPC with the old-style .csproj files, but using the new-style
.csproj projects (supported by VS2017 and dotnet SDK) is recommended.

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/), [Grpc.Tools](https://www.nuget.org/packages/Grpc.Tools/)
Expand All @@ -28,7 +33,7 @@ BUILD
# Using Monodevelop or Xamarin Studio

The nuget add-in available for Xamarin Studio and Monodevelop IDEs is too old to
download all of the nuget dependencies of gRPC. One alternative to is to use the dotnet command line tools instead (see [helloworld-from-cli]).
download all of the nuget dependencies of gRPC.

Using these IDEs, a workaround is as follows:
* Obtain a nuget executable for your platform and update it with
Expand Down Expand Up @@ -62,6 +67,5 @@ Tutorial

You can find a more detailed tutorial in [gRPC Basics: C#][]

[helloworld-from-cli]:../helloworld-from-cli/README.md
[helloworld.proto]:../../protos/helloworld.proto
[gRPC Basics: C#]:https://grpc.io/docs/tutorials/basic/csharp.html

0 comments on commit 1a70151

Please sign in to comment.