更新README.md，详述编译和运行步骤

增加了关于如何生成和编译项目的详细说明，包括使用`go generate`生成必要文件以及`go build`的具体命令与参数。同时补充了运行参数、配置文件结构及日后升级计划等内容。

README.md

@@ -26,16 +26,133 @@
 
 ## 编译
 
-使用请先在项目根目录执行`go:generate ./...`，随后执行`go build github.com/SongZihuan/BackendServerTemplate/src/cmd/<lionv1/tigerv1>`进行正常编译即可。
-**注意：把`<lionv1/tigerv1>`替换成你具体想编译的包名，最终指令例如：go build github.com/SongZihuan/BackendServerTemplate/src/cmd/lionv1**
+### 生成
 
-日后支持：
+每次编译器请先运行`go generate`命令，生成编译所需要的文件。
 
-* 添加编译参数，允许编译时注入编译时间和`git commit id`。
+编译所需要的文件：
 
-### 运行
-执行编译好的可执行文件即可。具体命令行参数可参见上文。注意编译时选择的目标平台要与运行平台一致。
+* `build_data.txt` 构建日期（Unix 时间戳，单位：秒）
+* `commit_data.txt` 构建的`git`（若有）的`commit`所对应的`hash`值（完整）。
+* `tag_data.txt` 构建时最新的`git`（若有）的标签名（若有），用于作为语义化版本。可以以`v`或`V`开头，后接语义化版本号。若非语义化版本号，则标签数据会忽略（相当于无标签）。
+* `tag_commit_data.txt` 上述（`tag_data.txt`）对标签（若有）所指的`commit`的`hash`值（完整）。若该值与`commit_data.txt`不同，则版本号会加上`+dev`标识。
+* `random_data.txt` 一串随机数（40个字符，和`commit`的`hash`长度相同，由数字和小写字母组成）。
+
+在项目根目录下执行：
+```shell
+$ go generate ./...
+```
+
+其中，`./...`表示执行当前目录下的所有（含本目录和递归的子目录）`go:generate`命令。
+
+### 编译
+
+使用`go build`指令进行编译。如何包位于`github.com/SongZihuan/BackendServerTemplate/src/cmd/`下，例如`github.com/SongZihuan/BackendServerTemplate/src/cmd/lionv1`
+
+所以，编译命令如下（以`lionv1`为例）：
+```shell
+$ go build github.com/SongZihuan/BackendServerTemplate/src/cmd/lionv1
+```
+
+若用于开发环境，可以按如下方式编译：
+```shell
+$ go build -o lionv1 -trimpath -ldflags='-s -w -extldflags "-static"' -gcflags='-O4 -inline=1' github.com/SongZihuan/BackendServerTemplate/src/cmd/lionv1
+```
+
+其中：
+ * `-o lionv1` 表示输出二进制文件的路径和名称
+   * Windows： `-o lionv1.exe`
+   * Linux/MacOS：`-o lionv1`
+ * `-trimpath` 表示擦除二进制文件中关于源码目录的信息，可以压缩二进制文件体积和包含隐私。
+ * `-ldflags='-s -w'` 是传递给链接器的参数。
+   * `-s` 表示去掉符号和调试信息，可以减少二进制文件大小，同时增加反编译的难度。
+   * `-w` 表示去掉`DWARF`调试信息，可以减少二进制文件大小，同时增加反编译的难度。
+   * `-extldflags "-static"` 是传递给外部链接器的参数。
+     * `-static` 表示外部链接器生成静态链接文件（实际上我几乎从真正看过这个参数的作用，因为`go`本身就会优先以静态形式链接库文件，这个参数可能和`cgo`搭配更合适）。
+ * `-gcflags='-O4 -inline=1'` 是传递给编译器的参数。
+   * `-O4` 启用最大优化。
+   * `-inline=1` 内联的积极程度。支持-1、0、1、2、3。数值越大约积极，-1为禁止内联，0为默认模式。内联越积极，可以提高一定性能，但可能让二进制文件膨胀变大。
+
+## 运行
+执行编译好地可执行文件即可。
+**注意编译时选择的目标平台要与运行平台一致。**
+
+### 运行参数
+
+* `-h`、`--help` 输出帮助文档（`Usage`）。**（终止运行参数）。**
+* `-v`、`--version` 输出版本号。**（终止运行参数）。**
+* `-l`、`--license` 输出软件协议。**（终止运行参数）。**
+* `-r`、`--report` 输出程序反馈、报告方式文档。**（终止运行参数）。**
+* `-n`、`--name` 设置项目名称（需要一个字符串参数）
+* `-c`、`--config` 配置文件位置（可提供一个字符串参数作为路径指向配置文件，默认值为：`config.yaml`）。
+* `-o`、`--output-config` 反向输出配置文件（默认不输出，若提供一个路径则会输出到该路径所指处）。未知配置项不会输出，未设定配置项则以默认值（若有）输出。**前提：配置文件被正确导入和识别。**
+
+**终止运行参数：当命令行出现这些参数时，将只执行参数对应的功能，执行完成后不会继续运行后续服务。**
+
+### 配置文件
+
+```yaml
+# 等同于命令行参数的 --name ，但优先级高于命令行参数。
+name: Backend-Server-Template
+
+# 运行模式：debug、release、test。默认为debug。
+mode: debug
+
+# 时间地区，例如：UTC、Local（默认）、Asia/Shanghai
+time-zone: local
+
+# utc-date 和 timestamp 并非真实参数，而是启用 --output-config时反向输出的参数、表示配置文件的读取时间。
+utc-date: "2025-04-15 15:33:37"
+timestamp: 1744731217
+
+# 日志记录器的配置
+logger:
+    log-level: debug  # 日志记录等级：debug（输出debug和以上的） < info （输出info和以上的）< warn < error < panic < none（什么都不输出）
+    log-tag: enable  # 是否输出tag调试日志。
+    
+    warn-writer:  # debug、tag、info、warn日志的输出器
+        write-to-std: stdout  # 输出到标准输出或标准错误输出（为空则不启用）
+        write-to-file: ""  # 输出到固定文件（append）模式
+        write-to-dir-with-date: ""  # 输出到指定目录，并按日期分割，此处为输出路径
+        write-with-date-prefix: ""  # 配合 write-to-dir-with-date ，表示文件的输出前缀
+        
+    error-writer:  # error、panic日志的输出器，含义同上
+        write-to-std: stdout
+        write-to-file: ""
+        write-to-dir-with-date: ""
+        write-with-date-prefix: ""
+
+signal: # 信号除了机制（管理接收程序退出信号）。sigkill 等信号是不可捕获的，是强制退出的，因此此处无法控制这类信号。虽然windows本身不具有Linux这种信号机制，但是Go在信号方面做了一层模拟，使得控制它ctrl+c可以转换为相应信号。
+    sigint-exit: enable  # 收到 sigint 信号后退出
+    sigterm-exit: enable  # 收到 sigterm 信号后退出
+    sighup-exit: enable  # 收到 sighup 信号后退出
+    sigquit-exit: enable  # 收到 sigquit 信号后退出
+
+server:  # 系统执行服务所需要的参数
+    stop-wait-time: 10s  # 服务退出时，等待清理结束的最长时间。
+```
+
+### 一些值的设定
+
+* `Name` 系统名称：
+  * 第一优先级：配置文件中的设定
+  * 第二优先级：命令行参数
+  * 最后优先级：项目根目录下Name文件（仅第一行有效、不包含换行符）
+* `SemanticVersioning` 语义化版本号：
+  * 第一优先级：项目根目录下的`Version`文件，可以`v`或`V`开头，后接语义化版本号，否则视为不满足要求进入第二优先级。
+  * 第二优先级：读取`git`中最新的`tag`，可以`v`或`V`开头，后接语义化版本号，否则视为不满足要求进入第二优先级。
+    若最新的tag对应的提交不是当前的提交（且无`dev`标识），则添加`+dev-时间戳-当前版本提交的哈希值`到语义化版本号中。
+  * 第三优先级：若无`tag`，但有当前提交记录的哈希值，则版本号为`0.0.0+dev-时间戳-当前版本提交的哈希值`。
+  * 最后优先级：使用随机版本号，版本号为`0.0.0+dev-时间戳-随机值`，随机值在执行`go generate`时生成（位于文件`random_data.txt`中），`go build`后固定。
+* `Version` 版本号：`SemanticVersioning`前添加`v`的字符串。
+
+## 日后升级计划
+
+1. Windows的`Console`机制的利用。
+2. 单元测试
+3. GitHub Action
 
 ## 协议
+
 本软件基于 [MIT LICENSE](/LICENSE) 发布。
-了解更多关于 MIT LICENSE , 请 [点击此处](https://mit-license.song-zh.com) 。
+了解更多关于 MIT LICENSE，请 [点击此处](https://mit-license.song-zh.com) 。