aboutsummaryrefslogtreecommitdiff
path: root/csharp/README.md
diff options
context:
space:
mode:
authorJon Skeet <jonskeet@google.com>2015-07-17 08:26:04 +0100
committerJon Skeet <jonskeet@google.com>2015-07-17 08:26:04 +0100
commit59eeebee870332ea2b9085688ba524c69311f662 (patch)
tree4300e8aeaff6a3b706c398496a692f5ed25f43b7 /csharp/README.md
parent0f442a7533b1d06ce0092b28f10af481b99e1369 (diff)
downloadprotobuf-59eeebee870332ea2b9085688ba524c69311f662.tar.gz
protobuf-59eeebee870332ea2b9085688ba524c69311f662.tar.bz2
protobuf-59eeebee870332ea2b9085688ba524c69311f662.zip
First pass at the big rename from ProtocolBuffers to Google.Protobuf.
We'll see what I've missed when CI fails...
Diffstat (limited to 'csharp/README.md')
-rw-r--r--csharp/README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/csharp/README.md b/csharp/README.md
index 72f55521..82e9f432 100644
--- a/csharp/README.md
+++ b/csharp/README.md
@@ -18,14 +18,14 @@ well as cloning, however.
Usage
=====
-The easiest way to use C# protocol buffers in your project is to use the [Google.ProtocolBuffers NuGet package](http://www.nuget.org/packages/Google.ProtocolBuffers/). This package is the legacy package for C# protocol buffers, but it will work fine with C# code generated by `protoc` if you use proto2 syntax (The API of the runtime library haven't changed so far).
-
-We will definitely release a new NuGet package for the runtime library in the future. The new runtime library WILL contain significant semantic, backwardly-incompatible changes in proto handling (mostly because we will be adding proto3 support and we will be using that oportunity to make some design changes). So keep in mind that you will need to regenerate your proto files and switch to a new NuGet package once the new version of runtime library becomes available.
+Use `protoc` with the `--csharp_out` option to generate C# files in the specified directory.
+Include these in your C# project, and add a reference to the `Google.Protobuf` project. Currently
+there is no NuGet package for this, but we will be building one as soon as the API is stable.
Building
========
-Open the `src/ProtocolBuffers.sln` solution in Visual Studio. Click "Build solution" to build the solution. You should be able to run the NUnit test from Test Explorer (you might need to install NUnit Visual Studio add-in).
+Open the `src/Google.Protobuf.sln` solution in Visual Studio. Click "Build solution" to build the solution. You should be able to run the NUnit test from Test Explorer (you might need to install NUnit Visual Studio add-in).
Supported Visual Studio versions are VS2013 (update 4) and VS2015. On Linux, you can also use Monodevelop 5.9 (older versions might work fine).