Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,18 +113,9 @@ documentation](https://github.com/real-logic/simple-binary-encoding/blob/master/

C# Build
--------
As of May 2017, the CSharp build is considered a preview release. API stability is not yet guaranteed. User and Developer guides are not yet released or are incomplete.
Users of CSharp generated code should see the [user documentation](https://github.com/real-logic/simple-binary-encoding/wiki/Csharp-User-Guide).

First build using Gradle to generate the SBE jar and then use it to generate the C# code used for testing and the examples.

$ ./gradlew
$ ./gradlew generateCSharpCodecs

You can then use the [Visual Studio 2017 Community solution](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/csharp.sln) to build and explore the example. This solution also builds some tests which can be run via the provided [runtests.sh](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/runtests.sh) script.

Users of CSharp generated code should see the [user documentation (coming)](https://github.com/real-logic/simple-binary-encoding/wiki/Csharp-User-Guide).

Developers wishing to enhance the CSharp generator should see the [developer documentation (coming)](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/README.md)
Developers wishing to enhance the CSharp generator should see the [developer documentation](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/README.md)


License (See LICENSE file for full license)
Expand Down
15 changes: 10 additions & 5 deletions csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Java and gradlew are used to build the generator.

git bash and shell scripts are used for scripting.

The C# code is built using Visual Studio Community 2017.
The C# code was originally built using Visual Studio Community 2017.

The code, samples, tests and nuget package can be built/run using the [dotnet core sdk](https://www.microsoft.com/net/download):

Expand All @@ -20,6 +20,13 @@ The code, samples, tests and nuget package can be built/run using the [dotnet co

## Release Notes

### 1.13.0

* Many build system improvements
* Better inlining support
* Issue #660 Add Length() and GetBytes() methods for VarStrings
* Add csharp code-gen time property that allows squashing of namespace

### 0.1.8.1-beta-2

C# Span support has been added to the code generation, and a set of corresponding utilities added to sbe-dll `DirectBuffer`. It is now possible to copy to/from a `Span<byte>` where previously only `byte[]` types were supported. This introduces a dependency on the [`System.Memory`](https://www.nuget.org/packages/System.Memory/) nuget package both for sbe-dll and generated code produced by sbe-tool.
Expand Down Expand Up @@ -78,8 +85,6 @@ For now you can:

* build the SBE csharp generator using `gradlew`
* generate the csharp codecs using `gradlew GenerateCSharpCodecs`
* Use the [Visual Studio 2017 Community solution](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/csharp.sln) to build the solution, run the unit tests, examples and benchmarks
* Use the command script
* [csharpbuild.cmd](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/csharpbuild.cmd) to build the dotnet core support
* Use the bash script [build.sh](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/build.sh) to run the tests
* Use the bash script [runtests.sh](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/runtests.sh) to run the tests
* Build the nuget package via [do-release.sh](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/.nuget/do-release.sh) although this remains a largely manual process.
* Use the bash script [pack.sh](https://github.com/real-logic/simple-binary-encoding/blob/master/csharp/pack.sh) to create the nuget package
2 changes: 1 addition & 1 deletion csharp/sbe-dll/sbe-dll.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<RepositoryUrl>https://github.com/real-logic/simple-binary-encoding</RepositoryUrl>
<PackageTags>SBE;Marshaling;Low;Latency;Simple;Binary;Encoding</PackageTags>
<PackageId>sbe-dll</PackageId>
<PackageVersion>0.1.12.1-beta-3</PackageVersion>
<PackageVersion>1.13.0</PackageVersion>
<Title>Simple Binary Encoding for .NET</Title>
<Description>This package contains all you need to define SBE messages and generate C# encoders and decoders. See https://github.com/real-logic/simple-binary-encoding for more detailed instructions</Description>
<RepositoryType>git</RepositoryType>
Expand Down