docs: 文档大改 (#20)

Author: DuckDuckStudio

.github/ISSUE_TEMPLATE/bug_feedback.yml

@@ -17,9 +17,9 @@ body:
       label: 选择一个问题类别
       description: 你遇到了什么样的问题?
       options:
+        - 使用问题
         - 安装问题
         - 依赖问题
-        - 使用问题
         - 其他
     validations:
       required: true
@@ -37,26 +37,7 @@ body:
       required: true
   - type: textarea
     attributes:
-      label: 实际行为
-      placeholder: 你遇到的情况是什么样的
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: 预期行为
-      placeholder: 正常情况下应该是什么样的
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: 确认相关信息
-      description: 有没有一些其他信息？例如您安装的库？等等。
-      render: raw
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: 屏幕截图或日志
-      description: 请上传你记录的日志/屏幕截图，因为它们将帮助我们找到问题的根本原因。如果有复现视频最好了！
+      label: 其他信息
+      description: 例如你记录的日志/屏幕截图，它们将帮助我们找到问题的根本原因。
     validations:
       required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -5,8 +5,7 @@ labels: ["新功能","DEV-需要注意"]
 body:
   - type: markdown
     attributes:
-      value: |
-        感谢您抽出时间与我们讨论新功能的想法！
+      value: 感谢您抽出时间与我们讨论新功能的想法！
   - type: checkboxes
     attributes:
       label: 在继续之前，请确认以下内容
@@ -26,13 +25,13 @@ body:
       required: true
   - type: textarea
     attributes:
-      label: 为什么需要实现此功能 (可选)
+      label: 为什么需要实现此功能
       placeholder: 告诉我们为什么需要这个功能？能带来什么好处？ (建议填写此字段，这对实施很有帮助!)
     validations:
       required: false
   - type: textarea
     attributes:
-      label: 对于实施该功能的方法的建议 (可选)
+      label: 对于实施该功能的方法的建议
       placeholder: 建议我们如何实现这一点 (建议填写此字段，这对实施很有帮助!)
     validations:
       required: false

.github/ISSUE_TEMPLATE/preference_adjective.yml

@@ -5,27 +5,21 @@ labels: ["优化","DEV-需要注意"]
 body:
   - type: markdown
     attributes:
-      value: |
-        感谢您抽出时间与我们讨论关于优化的想法！
-  - type: textarea
-    attributes:
-      label: 是对哪些方面的优化?
-    validations:
-      required: true
+      value: 感谢您抽出时间与我们讨论关于优化的想法！
   - type: textarea
     attributes:
       label: 需要做什么优化?
     validations:
       required: true
   - type: textarea
     attributes:
-      label: 为什么要这样优化? (可选)
+      label: 为什么要这样优化?
       placeholder: 告诉我们为什么要这样优化？能带来什么好处？ (建议填写此字段，这对实施很有帮助!)
     validations:
       required: false
   - type: textarea
     attributes:
-      label: 对于实施该优化的方法的建议 (可选)
+      label: 对于实施该优化的方法的建议
       placeholder: 建议我们如何实现这一点 (建议填写此字段，这对实施很有帮助!)
     validations:
       required: false

README.md

@@ -1,10 +1,6 @@
 # Sundry
 sundry 是一个 WinGet 本地清单管理工具，让您更方便地移除清单、修改清单，还可以辅助更新清单。  
 
-## 代码说明
-### 为什么有些简介中的功能在发行版中没有
-简介中的功能我都在本地写好了，这个工具本来是我自己本地用的，传之前需要一段时间修改。  
-
 ## 使用说明
 当您获取本工具后，请先使用这个命令初始化配置文件:  
 
@@ -30,14 +26,228 @@ sundry config show
 sundry config [条目] [值]
 ```
 
-更多可用命令可以使用此命令查看:  
+更多可用命令请见下方示例。  
+
+## 可用命令
+
+> Sundry [1.2.7](https://github.com/DuckDuckStudio/Sundry/releases/tag/1.2.7)
+
+<details>
+  <summary><code>sundry help</code></summary>
+
+![Sundry help 命令展示图。该命令用于输出 Sundry 帮助内容。](docs/photos/README/Demo/Commands/help.png)  
+
+- 别名: 任何非命令字符
+- 作用: 显示 Sundry 帮助
+
+</details>
+
+
+<details>
+  <summary><code>sundry ver</code></summary>
+
+![Sundry ver 命令展示图。该命令用于输出 Sundry 的版本和安装位置。](docs/photos/README/Demo/Commands/ver.png)  
+
+- 别名: `ver`, `版本`, `version`, `Version`, `--version`, `--ver`, `-v`
+- 作用: 显示 Sundry 版本和安装位置
+
+</details>
+
+
+<details>
+  <summary><code>sundry remove</code></summary>
+
+![Sundry remove 命令展示图。该命令用于从上游仓库（microsoft/winget-pkgs）中移除一个指定的软件包的指定版本，并带上理由（如果有）后自动创建拉取请求。](docs/photos/README/Demo/Commands/remove.png)  
+
+> 截图来自拉取请求: https://github.com/microsoft/winget-pkgs/pull/265074  
+
+- 别名: `移除`, `remove`
+- 作用: **移除一个指定的软件包的指定版本**，并在移除前自动检查该版本是否确实存在问题。可以指定理由或跳过自动检查。**默认理由为“安装程序URL在GitHub Action上返回了404”。**
+- 用法: `sundry remove <软件包标识符> <软件包版本> [是否跳过自动检查] [理由]`
+- 示例:
+  - 最少参数: `sundry remove DuckStudio.FufuTools 1.3.10`
+  - 跳过自动检查: `sundry remove DuckStudio.FufuTools 1.3.10 True`
+  - 指定理由: `sundry remove DuckStudio.FufuTools 1.3.10 "该版本存在一个已知问题"`
+  - 指定理由的同时跳过自动检查: `sundry remove DuckStudio.FufuTools 1.3.10 True "该版本存在一个已知问题"`
+
+</details>
+
+
+<details>
+  <summary><code>sundry modify</code></summary>
+
+![Sundry modify 命令展示图。该命令用于帮助用户打开需要修改的那个软件包的那个版本，并在修改完毕后自动向上游仓库（microsoft/winget-pkgs）提交拉取请求。](docs/photos/README/Demo/Commands/modify.png)  
+
+- 别名: `单改`, `单修改`, `modify`
+- 作用: **修改一个指定的软件包的指定版本的清单**，并在修改完后自动提交拉取请求。
+- 用法: `sundry modify <软件包标识符> <版本> [理由/解决的议题]`
+- 示例:
+  - 最少参数: `sundry modify XBMCFoundation.Kodi 18.2.0.0 ` (https://github.com/microsoft/winget-pkgs/pull/267613)
+  - 指定理由: `sundry modify XBMCFoundation.Kodi 18.3.0.0 "替换 HTTP 为 HTTPS"` (https://github.com/microsoft/winget-pkgs/pull/267614)
+  - 链接议题:
+    - 使用议题 URL: `sundry modify DuckStudio.Sundry 1.2.6 "https://github.com/microsoft/winget-pkgs/issues/267539"`
+    - 使用议题纯数字编号: `sundry modify DuckStudio.Sundry 1.2.6 "267539"`
+    - 使用议题编号: `sundry modify DuckStudio.Sundry 1.2.6 "#267539"`
+  - 指定理由的同时链接议题: 
+    ```pwsh
+    sundry modify DuckStudio.Sundry 1.2.6 "一些修改。
+    - Resolves https://github.com/microsoft/winget-pkgs/issues/267539"
+    ```
+    > GitHub Docs: [使用关键词将拉取请求链接到议题](https://docs.github.com/zh/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)  
+
+</details>
+
+
+<details>
+  <summary><code>sundry ignore</code></summary>
+
+![Sundry ignore 命令展示图。该命令用于管理 winget-tools 中的检测脚本的忽略字段。](docs/photos/README/Demo/Commands/ignore.png)  
+
+- 别名: `忽略`, `检查忽略`, `ignore`
+- 作用: **管理 [winget-tools](https://github.com/DuckDuckStudio/winget-tools/) 中的检测脚本的忽略字段。**
+- 用法: `sundry ignore <add/remove/edit/list> [忽略字段] [理由]`
+- 示例:
+  - 添加忽略字段: `sundry ignore add "https://www.argyllcms.com/" "服务器冲不动咖啡 (418)"`
+  - 移除忽略字段: `sundry ignore remove "https://www.argyllcms.com/" "又冲得动了"`
+  - 编辑忽略字段: `sundry ignore edit`
+  - 列出所有忽略字段: `sundry ignore list`
+
+</details>
+
+
+<details>
+  <summary><code>sundry cat</code></summary>
+
+![Sundry cat 命令展示图。该命令用于获取指定软件包标识符的指定版本的清单，可以指定获取所有清单或某个类型的清单。](docs/photos/README/Demo/Commands/cat.png)  
 
+- 别名: 没有别名，只能用 `cat`。
+- 作用: **获取指定软件包标识符的指定版本的清单**，可以指定获取所有清单或某个类型的清单。
+- 用法: `sundry cat <软件包标识符> <版本> [清单类型] [区域设置(如果是locale类型)]`
+- 示例:
+  - 获取所有清单: `sundry cat DuckStudio.Sundry 1.2.3`
+    - 亦可使用 `sundry cat DuckStudio.Sundry 1.2.3 all`
+    - 除 `all` 外还可用 `全部`, `所有`
+  - 获取指定类型的清单:
+    - 安装程序清单: `sundry cat DuckStudio.Sundry 1.2.3 i`
+      - 可以用 `installer`, `安装程序`, `安装`, `i`
+    - 区域清单: `sundry cat DuckStudio.Sundry 1.2.3 l zh-CN`
+      - 可以用 `locale`, `区域`, `区域设置`, `l`
+      - 必须指定具体哪个区域设置的清单
+    - 版本清单: `sundry cat DuckStudio.Sundry 1.2.3 v`
+      - 可以用 `version`, `ver`, `v`, `版本`
+
+</details>
+
+
+<details>
+  <summary><code>sundry sync</code></summary>
+
+![Sundry sync 命令展示图。该命令用于同步 fork 仓库和上游仓库的修改。](docs/photos/README/Demo/Commands/sync.png)  
+
+- 别名: `sync`, `同步`, `synchronize`, `sync-fork`
+- 作用: **同步 fork 仓库和上游仓库的修改。**
+- 用法: `sundry sync`
+- 示例: `sundry sync`
+
+</details>
+
+
+<details>
+  <summary><code>sundry repr</code></summary>
+
+![Sundry repr 命令展示图。该命令用于显示字符串的真面目，就像\n那种。](docs/photos/README/Demo/Commands/repr.png)  
+
+- 别名: 没有别名，只能用 `repr`。
+- 作用: 等效于 Python 的 `repr()`，用于获取字符串真实的样子。
+- 用法: `sundry repr <文件路径/文本内容> [编码(默认 UTF-8)]`
+- 示例:
+  - 文本:
+    ```pwsh
+    sundry repr "第一行
+    第二行"
+    ```
+  - 文件 (假设编码为 gbk): `sundry repr "D:/文件路径/文件.txt" "gbk"`
+
+</details>
+
+
+<details>
+  <summary><code>sundry config</code></summary>
+
+![Sundry config 命令展示图。该命令用于初始化和修改 Sundry 配置。](docs/photos/README/Demo/Commands/config.png)  
+
+- 别名: `config`, `配置`
+- 作用: 初始化和修改 Sundry 配置。
+- 用法: `sundry config <参数...>`
+- 示例:
+  - 初始化配置: `sundry config init`
+  - 显示当前配置: `sundry config show`
+  - 修改配置项: `sundry config signature no`
+
+</details>
+
+
+<details>
+  <summary><code>sundry revert</code></summary>
+
+![Sundry revert 命令展示图。该命令用于还原本地仓库的修改，如果 Sundry 在修改的某个过程中崩溃了，则可以使用此命令还原 Sundry 做的修改。](docs/photos/README/Demo/Commands/revert.png)  
+
+- 别名: `还原`, `revert`
+- 作用: **还原本地仓库的修改**，如果 Sundry 在修改的某个过程中崩溃了，则可以使用此命令还原 Sundry 做的修改。
+- 用法: `sundry revert <仓库> <是否已提交> <是否丢弃>`
+- 示例:
+  - 还原所有仓库、未提交、丢弃: `sundry revert all n y`
+  - 其他类似
+
+</details>
+
+
+<details>
+  <summary><code>sundry fun</code></summary>
+
+![Sundry fun 命令展示图。该命令用于管理 Sundry 的 fun.txt](docs/photos/README/Demo/Commands/fun.png)  
+
+- 别名: 没有别名，只能用 `fun`。
+- 作用: **管理 Sundry 的 `fun.txt`。**
+- 用法: `sundry fun <random/list/edit/add/remove/import> [参数...]`
+- 示例:
+  - 随机一个: `sundry fun` 或 `sundry fun random`
+    - 还可以使用 `sundry fun 随机`
+  - 列出所有: `sundry fun list`
+    - 可以用 `获取`, `读取`, `get`, `list`
+  - 编辑 fun.txt: `sundry fun edit`
+    - 可以用 `编辑`, `edit`, `打开`, `open`
+  - 添加新的: `sundry fun add "提问: 罗浮六御中谁最幸福? 答案: 符玄。因为她姓符。"`
+    - 可以用 `add`, `添加`
+  - 移除原来的: `sundry fun remove "Ciallo～(∠・ω< )⌒☆"`
+    - 可以用 `remove`, `移除`
+  - 从其他文件导入(覆盖): `sundry import "D:/文件路径/另一个fun.txt"`
+    - 可以用 `import`, `导入`
+
+</details>
+
+## 自己构建
+仓库下有一个[构建流](https://github.com/DuckDuckStudio/Sundry/blob/main/.github/workflows/build.yml)，你可以 fork 后直接运行，它会将结果上传为工件。  
+大概步骤是:  
+1. `cd` 到项目所在目录
+2. 更新代码中的版本号
+```pwsh
+python "自动化脚本/修改版本号.py" "2025.520.1314"
+```
+3. 安装依赖
+```pwsh
+python -m venv .venv
+& ".venv\Scripts\Activate.ps1"
+python.exe -m pip install --upgrade pip
+pip install -r "requirements.txt"
+pip install pyinstaller
+```
+4. 构建
+```pwsh
+pyinstaller --onefile --distpath="Release/pack" --name="sundry.exe" "src/sundry.py"
+```
+5. 复制所需文件
 ```bash
-sundry help
+cp -v src/fun.txt Release/pack
+cp -v LICENSE Release/pack
 ```
-
-## Demo
-这些 PR 是通过 Sundry 创建的:  
-- https://github.com/microsoft/winget-pkgs/pull/232363 (Remove)
-- https://github.com/microsoft/winget-pkgs/pull/229554 (Modify)
-- https://github.com/microsoft/winget-pkgs/pull/223814 (New version)