From f8473dfac7c56f64a85ffbd00f81ad2cc94eb4fc Mon Sep 17 00:00:00 2001
From: Aoran Zeng <ccmywish@qq.com>
Date: Sat, 12 Jul 2025 19:40:31 +0800
Subject: [PATCH] Update config doc

---
 rawstr4c/README.md | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)

diff --git a/rawstr4c/README.md b/rawstr4c/README.md
index c61c95c..96621fa 100644
--- a/rawstr4c/README.md
+++ b/rawstr4c/README.md
@@ -12,13 +12,17 @@
 
 # rawstr4c
 
+在你需要写一个复杂的C语言字符串的时候，请想起我... \" / \n ' \\ `
+
+<br>
+
 ## 配置语法
 
 ```markdown
 
-- config-name = `value`
+- config-item = `value`
 
-- config-name2 = `:mode`
+- config-item2 = `:mode`
 
 ```
 
@@ -30,9 +34,23 @@
 
 
 
-## 配置选项
+## 配置项
 
-- translate = `:hex` | `:oct` | `:escape`
+- output =
+
+  - `:terminal` = 在终端输出
+  - `:global-variable` = 输出为一个 `.h` 文件，定义为全局变量
+  - `:macro` = 输出为一个 `.h` 文件，定义为宏
+
+- output-file =
+
+  自定义生成的头文件名
+
+- translate =
+
+  - `:oct` = 八进制
+  - `:hex` = 十六进制
+  - `:escape` = 仅转义
 
 - postfix =
 
@@ -43,6 +61,10 @@
 
   生成的变量名，默认将会包含前缀和后缀
 
+- name-literally = `true` | `false`
+
+  无视其他配置项，直接使用 `name` 作为变量名
+
 - keep-prefix =
 
   变量名是否使用前缀