<NME> README.md
<BEF> # Coding WebIDE Backend

This repo is the backend of **Coding [WebIDE](https://ide.coding.net) Community Edition**

## Dev Environment

The backend is written in Java, and uses Maven as build tool. We recommend IntelliJ IDEA or Eclipse as IDE.

## Configuration

Everything in `/src/main/resources/application.properties`, including user info, project and database configs, etc.

## Packages

> **config:** Config classes  
> **dto:** dto classes  
> **entity:** Entity classes  
> **event:** Event-related classes  
> **git:** Classes that extend jgit class  
> **model:** Data model/structure  
> **repository:** Repository class, for database query purpose  
> **service:** Service classes  
> **tty:** A Java implementation of terminal  
> **utils:** Utils classes  
> **web:** Web-related classes, controllers etc.  

## Run the project

The backend first packs the frontend to webjar, and import as a maven dependency, thus packing the frontend is required before run.

Please refer to the script in `WebIDE-Workspace` repo, which provides a command to compile and run the whole project.

If you want to pack the frontend manually, please refer to `WebIDE-Frontend-Webjars` repo.

Once done packing, start the poject with `mvn spring-boot:run`.

打包完成后, 使用 `mvn spring-boot:run` 启动项目即可。

<MSG> update readme

<DFF> @@ -1,36 +1,38 @@
 # Coding WebIDE Backend
 
-This repo is the backend of **Coding [WebIDE](https://ide.coding.net) Community Edition**
+本项目是开源版 [WebIDE](https://ide.coding.net) 的后端程序。
 
-## Dev Environment
+## 开发环境
 
-The backend is written in Java, and uses Maven as build tool. We recommend IntelliJ IDEA or Eclipse as IDE.
+本项目使用 Maven 作为构建系统, 开发 IDE 可以为 Intellj IDEA 或 Eclipse, 只需要在按照 maven 类型导入即可。
 
-## Configuration
+## 配置文件
 
-Everything in `/src/main/resources/application.properties`, including user info, project and database configs, etc.
+* `/src/main/resources/application.properties` 包括用户、项目、数据库等配置
 
-## Packages
+> **SPACE_HOME:** 存放 workspace 的目录，默认为 ${"user.home"}/.workspace  
+> **server.port:** 应用启动的端口
 
-> **config:** Config classes  
-> **dto:** dto classes  
-> **entity:** Entity classes  
-> **event:** Event-related classes  
-> **git:** Classes that extend jgit class  
-> **model:** Data model/structure  
-> **repository:** Repository class, for database query purpose  
-> **service:** Service classes  
-> **tty:** A Java implementation of terminal  
-> **utils:** Utils classes  
-> **web:** Web-related classes, controllers etc.  
+## 包说明
 
-## Run the project
+> **config:** 项目配置类  
+> **dto:** dto 类  
+> **entity:** 实体类  
+> **event:** 与事件相关的类  
+> **git:** 扩展 jgit 的类  
+> **model:** 一些数据结构  
+> **repository:** repository 类, 用于数据库查询  
+> **service:** 服务类
+> **tty:** terminal 的 java 实现  
+> **utils:** 工具类  
+> **web:** 与 web 相关的类, 比如 controller 等  
 
-The backend first packs the frontend to webjar, and import as a maven dependency, thus packing the frontend is required before run.
+## 项目运行
 
-Please refer to the script in `WebIDE-Workspace` repo, which provides a command to compile and run the whole project.
+本项目将 `WebIDE` 前端打包成 `webjar`, 作为 maven 依赖引入, 因此在运行本项目前需要先打包前端项目。
 
-If you want to pack the frontend manually, please refer to `WebIDE-Frontend-Webjars` repo.
+可以参见 `WebIDE-Workspace` 项目的脚本, 该脚本提供了一键编译、运行 `WebIDE` 的功能)。
 
-Once done packing, start the poject with `mvn spring-boot:run`.
+如果想手动打包前端, 可以参见 `WebIDE-Frontend-Webjars` 项目。
 
+打包完成后, 使用 `mvn spring-boot:run` 启动项目即可。

update readme