Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
onerain88 committed May 15, 2020
1 parent 49aa2a0 commit 04d498d
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,39 @@ LeanCloud 数据存储,即时通讯 C# SDK,基于 .Net Standard 2.0 标准

[Release](https://github.com/leancloud/csharp-sdk/releases) 下载指定版本 SDK,暂不支持 Nuget 方式。

## 编译

[Repo](https://github.com/leancloud/csharp-sdk) clone 仓库,使用 Visual Studio 打开 csharp-sdk.sln 编译。
Unity 用户在编译完成后,请将 XX-Unity 工程中 Debug/Release 的 dlls 拷贝至 Unity 工程下的 Plugins 目录中即可使用。
其他 .Net 平台用户使用 XX 工程即可。
(XX 指 Storage,Realtime,LiveQuery 等)

## 项目结构

由于 Unity 平台并不是标准的 .Net Standard 2.0,所以在每个服务下单独拆分出了 XX-Unity 工程,源码和主工程是一致的,只是在依赖库方面有些区别。后面也可能针对 Unity 平台做些相关支持。

```
├── csharp-sdk.sln // 项目配置
├── Common // 公共库,包含基础功能
├── Storage // 存储服务
│   ├── Storage // .Net Standard 2.0 工程
│ ├── Storage-Unity // Unity 工程
│   └── Storage.Test // 单元测试
├── Realtime // 即时通讯服务
│   ├── Realtime // .Net Standard 2.0 工程
│   ├── Realtime-Unity // Unity 工程
│   └── Realtime.Test // 单元测试
├── LiveQuery // LiveQuery 服务
│   ├── LiveQuery // .Net Standard 2.0 工程
│   ├── LiveQuery-Unity // Unity 工程
│   └── LiveQuery.Test // 单元测试
├── Sample // 示例
│   ├── RealtimeApp // 即时通讯应用,主要测试断线重连
│   └── LiveQueryApp // LiveQuery 应用,主要测试断线重连
└── UnityLibs // Unity 依赖
└── Newtonsoft.Json.dll // Json 库,由于 Unity iOS AOT 的原因,不能使用 .Net Standard 2.0 版本
```

## 导入

```csharp
Expand Down

0 comments on commit 04d498d

Please sign in to comment.