readme.md

2023-06-07 02:39:44 +08:00
parent 77961f2b3e
commit 8ec10332f8
2 changed files with 116 additions and 4 deletions
--- a/Readme.md
+++ b/Readme.md
@@ -1,4 +1,95 @@
-###BITKit
-Dotnet框架，主要为Unity与asp.net提供服务
-服务提供者：  军火商小火柴
-联系方式:   shitchilly@gmail.com
+# BITKit——easy useful的.net框架(支持网络)
+
+> 所有项目都需要一个Framework，BITKit为你提供所有支持
+
+无论是小型，大型还是商业项目,你都可以用BITKit完成所有的需求
+
+特别是Unity和asp
+
+## Getting Started 使用指南
+
+该框架由于目前还没有用户，所以使用指南将包括在部分文件中
+
+### Prerequisites 项目使用条件
+
+你需要一些小小的nuget程序包，或者一些小小的Unity Packages
+```
+        UniTask             提供异步处理
+```
+```
+        Unity.Mathematics   提供数学结构
+```
+```
+(可选)   GameDesigner        提供主要的网络服务(未来可能会用内置KCP)
+```
+在Unity中,你还需要以下Plugins:
+
+```
+Sirenix         Odin       
+```
+```
+Demigiant       DOTween
+```
+```
+Rotary Heart    SerializableDictionaryLite      (已下架)
+```
+
+### Installation 安装
+
+1.从Git Clone此项目
+
+[该项目Git链接](http://server.bitfall.icu:3000/root/BITKit.git) 右键复制
+#### Unity:
+
+
+```
+在 PackagesManager 运行 "Add Package From Git Url" 
+```
+#### Net Core:
+
+```
+从Git Clone该项目后，支持在解决方案中"添加现有项目"即可完成安装
+```
+
+### Usage example 使用示例
+```csharp
+//打包数据
+BITAssets.Build(myFile);
+//二进制和反二进制化数据
+BITBinary.Write(value);
+BITBinary.Read<T>(value);
+//注册远程指令
+INetProvider.AddCommandListener<MyCommand>(callback);
+//向服务器发送指令
+INetProvider.ServerCommand<MyCommand>();
+//向客户端发送指令
+INetProvider.ClientCommand<MyCommand>(64);
+```
+
+
+## Deployment 部署方法
+
+#### Unity      :直接Build项目
+#### Net Core   :直接发布项目
+
+## Contributing 贡献指南
+
+从Readme文件下方找到作者的联系方式，并直接联系作者
+
+## Release History 版本历史
+
+* 0.2.1
+    * 更新 `README.md`
+* 0.2.0
+    * 添加 `README.md`
+* 0.1.0
+    * 创建Git 仓库
+
+## Authors 关于作者
+
+* **军火商小火柴** - *Initial work* - [军火商小火柴](https://bitfall.icu)
+
+
+## License 授权协议
+
+这个项目 MIT 协议， 请点击 [LICENSE.md](LICENSE.md) 了解更多细节。