From dee028686de6613064a0cc7fa18e6d5143a9d830 Mon Sep 17 00:00:00 2001 From: feilong Date: Wed, 23 Mar 2022 14:15:27 +0800 Subject: [PATCH] improve readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 9a87499..3f3ef89 100644 --- a/README.md +++ b/README.md @@ -495,3 +495,24 @@ $code 在根目录下执行 `python main.py` 会合成技能树文件,合成的技能树文件: `data/tree.json` * 合成过程中,会自动检查每个目录下 `config.json` 里的 `node_id` 是否存在,不存在则生成 * 合成过程中,会自动检查每个知识点目录下 `config.json` 里的 `export` 里导出的习题配置,检查是否存在`exercise_id` 字段,如果不存在则生成 + +## FAQ + +**难度目录是固定的么?** + +1. data/xxx 目录下的子目录是固定的初/中/高三个难度等级目录 + +**如何增加章目录?** + +1. 在VSCode里打开项目仓库 +2. 在对应的难度等级目录新建章目录,例如在 data/1.xxx初阶/ 下新建章文件夹,data/1.xxx初阶/1.yyy +3. 在项目根目录下执行 python main.py 脚本,会自动生成章的配置文件 data/1.xxx初阶/1.yyy/config.json + +**如何增加节目录?**: +1. 直接在VSCode里创建文件夹,例如 "data/1.xxx初阶/1.yyy/2.zzz" +2. 项目根目录下执行 python main.py 会自动为新增节创建配置文件 data/1.xxx初阶/1.yyy/2.zzz/config.json + +**如何在节下新增一个习题**: +3. 在"data/1.xxx初阶/1.yyy/2.zzz" 目录下添加一个 markdown 文件编辑,例如 yyy.md,按照习题markdown格式编辑习题。 +4. md编辑完后,可以再次执行 python main.py 会自动生成同名的 yyy.json,并将 yyy.json 添加到config.json 的export数组里。 +5. yyy.json里的author信息放作者 CSDN ID。 \ No newline at end of file -- GitLab