[rocketmq-client-csharp] branch master updated: Add instruction on build, test and running examples

[li...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lizhanhui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-client-csharp.git


The following commit(s) were added to refs/heads/master by this push:
     new 9c5b36e  Add instruction on build, test and running examples
9c5b36e is described below

commit 9c5b36e4fbf7a4c90d87eda282f725b1bc254eae
Author: ZhanhuiLi <sh...@alibaba-inc.com>
AuthorDate: Sat Feb 12 15:32:08 2022 +0800

    Add instruction on build, test and running examples
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index a5c9190..8191957 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,30 @@ Architecture
 Basically, this project would follow the same paradigm of [rocketmq-client-cpp v5.0.0](https://github.com/apache/rocketmq-client-cpp/tree/main). Namely, we would build the whole client following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-dotnet](https://github.com/grpc/grpc-dotnet), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission.
 
 
+How to build
+-----------------
+Layout of this project roughly follows [this guide](https://docs.microsoft.com/en-us/dotnet/core/tutorials/library-with-visual-studio-code?pivots=dotnet-5-0). The solution contains a class library, a unit test module and an example console module.
+
+1. Install dotnet tool chains following instructions [here](https://dotnet.microsoft.com/en-us/download);
+2. Visual Studio Code with official C# plugin is used during development;
+
+Assuming you are at the home of this repository,
+#### Build
+
+```sh
+dotnet build
+```
+
+#### Run Unit Tests
+```sh
+dotnet test
+```
+
+#### Run Examples
+```sh
+dotnet run -p examples
+```
+
 License
 ------------------
 This project follows [Apache License Version 2.0](./LICENSE).