Ver código fonte

Update docs. (#95)

* Update docs.

* Fix mongo download link.

* Change download link.
Junyan Liu 8 anos atrás
pai
commit
a57408a922
5 arquivos alterados com 11 adições e 5 exclusões
  1. 5 2
      Readme-zh.md
  2. 6 3
      Readme.md
  3. BIN
      screenshots/1.jpg
  4. BIN
      screenshots/2.jpg
  5. BIN
      screenshots/3.jpg

+ 5 - 2
Readme-zh.md

@@ -6,7 +6,9 @@
 
 ## 介绍
 
-`MineCase` 是使用 `.NET Core` 开发的一个跨平台、分布式的 `Minecraft` 服务端应用,使用了 `Orleans` 框架。<br>
+`MineCase` 是一个跨平台、分布式的 `Minecraft` 服务端应用。
+
+本项目使用 `.NET Core` 编写,基于 [orleans](https://github.com/dotnet/orleans) 框架。它通过 Actor 模型将各个模块分离开来,从而构建一个高效的分布式系统。
 
 目前仅支持 `Minecraft` [1.12](https://minecraft.net/en-us/article/minecraft-112-pre-release-6) 的版本。
 
@@ -30,7 +32,8 @@ docker-compose up
 
 #### 前置要求
 
-你需要先安装 `.NET Core` sdk2.0,可以在 [这里](https://www.microsoft.com/net/download) 找到你需要的版本。
+* 你需要先安装 **`.NET Core` sdk 2.0**,可以在 [这里](https://www.microsoft.com/net/download) 找到你需要的版本。
+* **MongoDB**, 你可以从 [这里](https://www.mongodb.com/download-center?jmp=nav#community) 下载。
 
 #### 获取源码
 

+ 6 - 3
Readme.md

@@ -6,9 +6,11 @@
 
 ## Introduction
 
-`MineCase` is a cross-platform, distributed `Minecraft` server application developed using `.NET Core` that uses the `Orleans` framework.
+`MineCase` is a cross-platform application with distributed server of `Minecraft`. 
 
-We currently support [Release 1.12](https://minecraft.net/en-us/article/minecraft-112-pre-release-6) Minecraft protocol versions.
+It's written in `.NET Core` and based on the [orleans](https://github.com/dotnet/orleans) framework. It constructs a high-performance, distributed system by isolating different components through actor mode.
+
+We currently support [Release 1.12](https://minecraft.net/en-us/article/minecraft-112-pre-release-6) Minecraft protocol version.
 
 ## Setup
 
@@ -30,7 +32,8 @@ You can use `docker-compose stop` to stop the application。
 
 #### Pre-requirement
 
-You need to install `.NET Core` sdk 2.0 first, you can find the version you need from [here](https://www.microsoft.com/net/download).
+* You need to install **`.NET Core` sdk 2.0** first, you can find the version you need from [here](https://www.microsoft.com/net/download).
+* **MongoDB**, you can download it from [here](https://www.mongodb.com/download-center?jmp=nav#community).
 
 #### Get source
 

BIN
screenshots/1.jpg


BIN
screenshots/2.jpg


BIN
screenshots/3.jpg