# 更新软件包

Armory 支持更新软件包的 README 文件，以便灵活调整软件包的描述、适用范围、功能和使用指导等概述性信息。

# 前提条件

已 发布软件包，且待更新 README 的软件包版本已确认发布。

# 操作步骤

1. 在开始搜索框或任意文件夹地址栏输入“cmd”，打开终端。

2. 在终端执行如下命令，更新目标软件包的 README 文件。

   armory update-readme [<package-spec>] [--file ./path/to/README.md]
   

   参数说明如下：

   • package-spec（可选）：软件包 包名称说明符，用于指定要更新 README 的软件包名称、标签或版本。
   • --file ./path/to/README.md（可选）：指定要更新的 README 文件位置。
   说明：

   • 若指定了 package-spec 或 --file，则二者必须同时提供，且 package-spec 需包含标签或版本信息。
   • 若未指定 package-spec 和 --file，则客户端会在当前工作目录下查找 armory.json 及 README.md 或 README.txt，并根据 armory.json 中的软件包信息自动更新 README。因此，如果当前工作目录已包含目标软件包的 armory.json 和待更新的 README 文件，可直接执行 armory update-readme 进行更新。

   命令示例如下：

   armory update-readme @software_factory/tappas-dev@latest -f @software_factory/tappas-dev/README.md
   
   # 回显如下内容，表示更新成功：
   Using repository: http://10.12.**.**(default)
   Updating package @software_factory/tappas-dev@latest readme file using D:\software\Armory\@software_factory\tappas-dev\README.md ...
   Readme update success.