From 895d0b4823194eff5e1e962e93d6ff1d832a5871 Mon Sep 17 00:00:00 2001
From: Aoran Zeng <ccmywish@qq.com>
Date: Mon, 14 Jul 2025 17:36:44 +0800
Subject: [PATCH] Update doc

---
 tool/rawstr4c/README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/tool/rawstr4c/README.md b/tool/rawstr4c/README.md
index 1a723d2..dac275e 100644
--- a/tool/rawstr4c/README.md
+++ b/tool/rawstr4c/README.md
@@ -27,13 +27,30 @@ just rawstr4c ./src/recipe/ware
 
 
 
+## Convention
+
+一个配置文件，应使用这样的顺序:
+
+- section 标题
+- 对该变量的说明
+- 配置项
+- 配置项注释
+- code block (raw string)
+- 对 code block 内容的注释
+
+<br>
+
+
+
 ## 配置语法
 
 ```markdown
 
-- config-item = `value`
+- config-item1 = `:mode`
 
-- config-item2 = `:mode`
+- config-item2 = `true|false|yes|no`
+
+- config-item3 = `string value`
 
 ```