From c076ed866c97a67dd60e82534c91c981bfb5b6d3 Mon Sep 17 00:00:00 2001
From: feilong <fanfeilong@outlook.com>
Date: Wed, 23 Mar 2022 14:16:51 +0800
Subject: [PATCH] improve readme

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 041b446..2c9af63 100644
--- a/README.md
+++ b/README.md
@@ -194,3 +194,25 @@ while 1:
 * 合成过程中，会自动检查每个知识点目录下 `config.json` 里的 `export` 里导出的习题配置，检查是否存在`exercise_id` 字段，如果不存在则生成
 * 在 节 目录下根据需要，可以添加一些子目录用来测试代码，例如在 data/1.游戏开发入门进阶/1.简易游戏/1.HelloGame/ 节目录下，为了测试方便，增加了一个 test/ 子目录，放测试游戏代码
 * 开始游戏入门技能树构建之旅，GoodLuck! 
+
+
+## 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