add readme

README.md

@@ -2,6 +2,28 @@
 
 Rust 技能树
 
+## 环境准备
+
+技能树仓库提供了辅助的工具脚本和 git hook 程序，在开始编辑工作之前，需要初始化环境依赖，我们推荐使用 python 3.8 或更高版本的 python。
+
+首先，请确认系统中已经安装 python 和 git，然后执行下列命令克隆仓库：
+
+```shell
+git clone git@codechina.csdn.net:csdn/skill_tree_java.git
+```
+
+然后进入 skill_tree_java 目录，执行下列命令安装依赖：
+
+```shell
+pip install -r requrirements.txt
+```
+
+然后执行下列命令安装钩子：
+
+```shell
+pre-commit install
+```
+
 ## 初始化技能树
 
 技能树合成和id生成脚本目前用Python脚本统一处理
@@ -175,7 +197,15 @@ fn main() {
 
 ## 技能树合成
 
-在根目录下执行 `python main.py` 会合成技能树文件，合成的技能树文件: `data/tree.json`
-
+在根目录下执行 `python main.py` 会合成技能树文件，合成的技能树文件为: `data/tree.json`
+* 合成过程中，会检查章节目录下是否有 `config.json` 文件，如果没有，会自动生成，需要注意的是，这时 config.json是不完
+  整的，没有 keywords 信息
+* 每个知识点目录（即技能树最末端的叶子节点）的 config.json ，需要设定关键字，如果 `config.json` 的 keywords 为空，执行
+  main.py 会提示错误并中途退出，执行`git commit`时，commit 钩子也会拒绝提交
 * 合成过程中，会自动检查每个目录下 `config.json` 里的 `node_id` 是否存在，不存在则生成
-* 合成过程中，会自动检查每个知识点目录下 `config.json` 里的 `export` 里导出的习题配置，检查是否存在`exercise_id` 字段，如果不存在则生成
+* 合成过程中，会修复目录的序号，保持每一个章节目录的子目录总是从 1 开始的整数序列
+* 合成过程中，会自动检查每个知识点目录下的 markdown 文件，是否有对应的配置信息，如果不存在则生成
+    * 生成的习题配置信息中，author是根据git环境信息填写的，如果这个作者名不是您的csdn账户名，您可以手工编辑修改
+    * config.json 的 export 字段定义了同一个知识点下习题的顺序，如果需要定义不同的顺序，您可以手工调整
+    * 技能树仓库钩子和辅助工具都会检查信息完整性，并尝试做必要的修补，因此可能在提交时发现有一些新文件
+      生成，请在后续的提交中将它们也发送到服务器仓库
\ No newline at end of file