Skip to content

Commit 895d0b4

Browse files
committed
Update doc
1 parent 0fb89b8 commit 895d0b4

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

tool/rawstr4c/README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,30 @@ just rawstr4c ./src/recipe/ware
2727

2828

2929

30+
## Convention
31+
32+
一个配置文件,应使用这样的顺序:
33+
34+
- section 标题
35+
- 对该变量的说明
36+
- 配置项
37+
- 配置项注释
38+
- code block (raw string)
39+
- 对 code block 内容的注释
40+
41+
<br>
42+
43+
44+
3045
## 配置语法
3146

3247
```markdown
3348

34-
- config-item = `value`
49+
- config-item1 = `:mode`
50+
51+
- config-item2 = `true|false|yes|no`
3552

36-
- config-item2 = `:mode`
53+
- config-item3 = `string value`
3754

3855
```
3956

0 commit comments

Comments
 (0)