diff --git a/README.md b/README.md index a46494b6..cb577654 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,15 @@ ## 撰写方法 ### 文件命名 -每个章节建立一个md文件,如第11章的第3节,则建立**11.3.md**。 +每个章节建立一个md文件,如第11章的第3节,则建立**11.3.md**。 +### 代码文件 +代码文件置于src目录之下。每小节代码按目录存放。如第11章的第3节的代码保存于**src/11.3/**目录下。在正文中按需要添加代码。 -## 格式规范 -请参看已有章节的规范,要注意的是,每个章节在底部都需要有一个links节,包含“目录”,“上一节”和“下一节”的链接。 +## 格式规范 +### 正文 +请参看已有章节的规范,要注意的是,每个章节在底部都需要有一个links节,包含“目录”,“上一节”和“下一节”的链接。 +### 代码 +代码要**`go fmt`**后提交。注释文件注明其所属于章节。 ##如何编译 `build.go`依赖markdown的一个解析包,所以第一步先