diff --git a/README.md b/README.md index 8c25f4916b15148cdc9f9af20ac02808eb9040b4..61fbb3597d19e6044ae49bc653d5808f51b096fb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # skill_tree_java +本项目是 [CSDN 技能树](https://codechina.csdn.net/explore/topics/skill_tree) 的 Java 专项。 + +为了操作方便,在仓库中有一组微型的 Python 工具脚本,用于加工和维护技能树,一般情况下不用关注。对于项目贡献者, +主要维护的是技能树的目录结构和相关习题 + ## 环境准备 技能树仓库提供了辅助的工具脚本和 git hook 程序,在开始编辑工作之前,需要初始化环境依赖,我们推荐使用 python 3.8 或更高版本的 python。 @@ -64,13 +69,12 @@ pre-commit install } ``` - - ## 习题编辑 编辑者需要关注两个重点问题 - - 根据需要编辑技能树的目录,每个目录应该由`序号.标题`组成,序号的数字不需要精确的保持连续,只要是整数即可 - - 在知识点的目录下编写习题,目前推荐使用 markdown 格式,我们仅就这个格式的习题编辑进行介绍 +- 根据需要编辑技能树的目录,每个目录应该由`序号.标题`组成,序号的数字不需要精确的保持连续,只要是整数即可,在提交 + 前执行 `python main.py`,该脚本会辅助整理目录序号 +- 在知识点的目录下编写习题,目前推荐使用 markdown 格式,我们仅就这个格式的习题编辑进行介绍 如前文内容,我们在知识节点下增加习题 `HelloWord`的定义文件,即在`data/1.Java初阶/1.Java概述/1.什么是Java` 目录新建一个名为 `HelloWorld.md` 的文本文件,并编辑为: @@ -179,11 +183,16 @@ public class App { ## 技能树合成 -在`src`目录下执行 `python main.py -a tree` 会合成技能树文件,合成的技能树文件为: `data/tree.json` +在`src`目录下执行 `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` 是否存在,不存在则生成 +* 合成过程中,会修复目录的序号,保持每一个章节目录的子目录总是从 1 开始的整数序列 * 合成过程中,会自动检查每个知识点目录下的 markdown 文件,是否有对应的配置信息,如果不存在则生成 - * 生成的习题配置信息中,author是根据git环境信息填写的,如果这个作者名不是您的csdn账户名,您可以手工编辑修改 - * config.json 的 export 字段定义了同一个知识点下习题的顺序,如果需要定义不同的顺序,您可以手工调整 - * 技能树仓库钩子和辅助工具都会检查信息完整性,并尝试做必要的修补,因此可能在提交时发现有一些新文件 - 生成,请在后续的提交中将它们也发送到服务器仓库 + * 生成的习题配置信息中,author是根据git环境信息填写的,如果这个作者名不是您的csdn账户名,您可以手工编辑修改 + * config.json 的 export 字段定义了同一个知识点下习题的顺序,如果需要定义不同的顺序,您可以手工调整 + * 技能树仓库钩子和辅助工具都会检查信息完整性,并尝试做必要的修补,因此可能在提交时发现有一些新文件 + 生成,请在后续的提交中将它们也发送到服务器仓库