generate-readme-zh-twlisted

# 產生 README.md（繁體中文） ## 執行步驟 ### 1. 分析專案結構 讀取以下資訊（若存在）： - 專案檔：`*.csproj`、`*.sln`、`package.json`、`pyproject.toml`、`go.mod` 等 - 現有文件：`README.md`（若已存在，採 Merge 模式補齊，不全文重寫） - 目錄結構：掃描第一層與第二層目錄 - 設定檔：`appsettings.json`、`.env.example`、`docker-compose*.yml` 等 - CI/CD：`.github/workflows/`、`.gitlab-ci.yml` 等 - 授權：`LICENSE` ### 2. 判斷專案類型 依掃描結果分類： - **函式庫 / SDK**：提供安裝方式與 API 使用範例為主 - **Web API / 後端服務**：提供端點清單、啟動方式、環境變數說明為主 - **前端應用**：提供功能概述、啟動指令、建置流程為主 - **工具 / CLI**：提供指令使用方式與參數說明為主 - **設定集 / 文件庫**（如本 `.ai-agents` 專案）：提供結構說明與使用方式為主 ### 3. 產生 README 內容 依專案類型組合適當的章節，使用以下結構為基礎： ```markdown # 專案名稱 > 一句話描述專案的核心功能與適用對象。 ## 功能特色 - [功能 1] - [功能 2] ## 系統需求 - [執行環境版本，如 .NET 9、Node.js 22+] ## 快速開始 ### 安裝 [安裝指令或步驟] ### 執行 [啟動指令] ## 專案結構 [目錄結構說明，使用 tree 格式或表格] ## 設定 [環境變數或設定檔說明，敏感資訊以 `<YOUR_VALUE>` 標示] ## 使用方式 [核心功能的使用範例，包含程式碼區塊] ## 開發流程 ### 測試 ```bash # 執行所有單元測試 [測試指令，如 dotnet test / npm test / pytest] # 執行特定測試 [指令範例] ``` ### 格式化 ```bash # 格式化程式碼 [格式化指令，如 dotnet format / npm run lint:fix] ``` ### 建置 ```bash # 建置專案 [建置指令，如 dotnet build / npm run build] ``` ## 貢獻指南 [PR 流程、分支命名慣例的簡要說明，若有的話] ## 授權條款 [授權名稱與 LICENSE 連結，若 LICENSE 檔案存在] ``` **章節選用原則：** - 無需每個章節都產出，視專案實際內容決定。 - 若某章節資訊無法從現有檔案取得，略去該章節（不寫「待補充」）。 - 若已有 `LICENSE`，必須加入「授權條款」章節。 - 若專案有可執行的測試、格式化或建置指令，必須加入「開發流程」章節。 ### 4. 語言與格式規範 - 全文使用繁體中文（台灣用語），程式碼區塊與指令保持英文。 - 中英文混排時，中文字與英文/數字之間加一個半形空格。 - 技術術語保留英文（如 Docker、API、NuGet）。 - 標點符號使用全形（`。，：`），程式碼區塊內維持原樣。 ### 5. 寫入結果 **已存在 README.md**：採 Merge 模式，依現有結構插入缺少的章節，保留使用