diff --git a/rt-thread-version/rt-thread-standard/development-guide/package/figures/make_software_index-new.png b/rt-thread-version/rt-thread-standard/development-guide/package/figures/make_software_index-new.png new file mode 100644 index 0000000000000000000000000000000000000000..b51a51eec212c4612b238353fce84396fcec854e Binary files /dev/null and b/rt-thread-version/rt-thread-standard/development-guide/package/figures/make_software_index-new.png differ diff --git a/rt-thread-version/rt-thread-standard/development-guide/package/package.md b/rt-thread-version/rt-thread-standard/development-guide/package/package.md index 3b01de162f7d7175daf79688d404d78d17e9f5b2..44ebe3a60a635a652a9b9490865ff27975b5f790 100644 --- a/rt-thread-version/rt-thread-standard/development-guide/package/package.md +++ b/rt-thread-version/rt-thread-standard/development-guide/package/package.md @@ -39,9 +39,10 @@ #### 使用索引生成向导 -我们可以使用 Env 的软件包索引生成向导功能来制作软件包索引,命令为 `pkgs --wizard`,大致流程如下如图所示: +我们可以使用 Env 的软件包索引生成向导功能来制作软件包索引,命令为 `pkgs --wizard`,大致流程如下如图所示,需要填入一下信息:包括软件包名称、软件包版本、软件包分类、作者信息、软件包使用的license、软件包地址等。 + +![image-20220922102421432](figures/make_software_index-new.png) -![image](./figures/make_software_index.png) 生成内容如下图所示: @@ -53,61 +54,79 @@ #### 修改 package.json 文件 -- **package.json 文件**介绍: +- **package.json 文件**介绍:**package.json** 是软件包的描述信息文件,由索引生成向导生成,如下所示,有一部分信息需要再次手动修改或者添加。 ```json { - "name" : "pahomqtt", - "description" : "a pahomqtt package for rt-thread", # 软件包描述信息 - "keywords" : [ - "pahomqtt" - ], - "site" : [ + "name": "pahomqtt", + "description": "Please add description of pahomqtt in English.", # 软件包的英文描述需要自行添加 + "description_zh": "请添加软件包 pahomqtt 的中文描述。", # 软件包的中文描述需要自行添加 + "enable": "PKG_USING_PAHOMQTT", + "keywords": [ + "pahomqtt" + ], + "category": "iot", + "author": { + "name": "RealThread", + "email": "package_team@rt-thread.com", + "github": "RealThread" + }, + "license": "EPL-1.0", + "repository": "https://github.com/RT-Thread-packages/paho-mqtt", + "icon": "unknown", # 软件包的中文描述需要自行添加 + "homepage": "https://github.com/RT-Thread-packages/paho-mqtt#readme", + "doc": "unknown", # 软件包的中文描述需要自行添加 + "site": [ { - "version" : "v1.0.0", - "URL" : "https://pahomqtt-1.0.0.zip", # 根据版本号修改软件包压缩包的下载地址 - "filename" : "pahomqtt-1.0.0.zip", - "VER_SHA" : "fill in the git version SHA value" # 压缩包形式无需填写 + "version": "v1.0.0", + "URL": "https://pahomqtt-1.0.0.zip", # 软件包的压缩包地址需要自行修改 + "filename": "pahomqtt-1.0.0.zip" }, { - "version" : "latest", # latest 版本 - "URL" : "https://xxxxx.git", # 可以填入 Git 仓库地址 - "filename" : "Null for git package", - "VER_SHA" : "fill in latest version branch name,such as mater" # 填入 SHA 值或者分支名 + "version": "latest", + "URL": "https://github.com/RT-Thread-packages/paho-mqtt.git", + "filename": "", + "VER_SHA": "master" } - ] + ] } ``` -关于文件中 `URL` 值,每个版本可以填入两种类型 : - -- **Git** :可以填入 Git 仓库地址和对应版本的 SHA 值。一般 `latest` 版本会在 **SHA** 填入`master`。 -- **压缩包** : 指定软件包压缩包的下载地址,此时无需填入 **SHA** 。 - -**package.json** 是软件包的描述信息文件,包括软件包名称,软件包描述,作者等信息,以及必须的 package 代码下载链接。另外,请务必包含许可证的说明,使用了哪种许可证( GPLv2,LGPLv2.1,MIT,Apache license v2.0,BSD 等)。 - 修改后的 package.json 大致如下: ```json { - "name" : "pahomqtt", - "description" : "Eclipse Paho MQTT C/C++ client for Embedded platforms", # 更新了描述信息 - "keywords" : [ - "pahomqtt" - ], - "site" : [ + "name": "pahomqtt", + "description": "Eclipse Paho MQTT C/C++ client for Embedded platforms", + "description_zh": "Eclipse 开源的 MQTT C/C++ 客户端", + "enable": "PKG_USING_PAHOMQTT", + "keywords": [ + "pahomqtt" + ], + "category": "iot", + "author": { + "name": "RealThread", + "email": "package_team@rt-thread.com", + "github": "RT-Thread-packages" + }, + "license": "EPL-1.0", + "repository": "https://github.com/RT-Thread-packages/paho-mqtt", + "icon": "https://www.rt-thread.org/qa/template/fxiaomi/style/image/logo.png", + "homepage": "https://github.com/RT-Thread-packages/paho-mqtt#readme", + "doc": "https://www.rt-thread.org/document/site/submodules/paho-mqtt/docs/introduction/", + "readme": "A mqtt package for rt-thread", + "site": [ { - "version" : "v1.0.0", # v1.0.0 版本 - "URL" : "https://github.com/RT-Thread-packages/paho-mqtt.git", # 更新了 git 仓库地址 - "filename" : "paho-mqtt-1.0.0.zip", - "VER_SHA" : "cff7e82e3a7b33e100106d34d1d6c82e7862e6ab" # 填入了指定版本的 SHA 值 + "version": "v1.0.0", + "URL": "https://github.com/RT-Thread-packages/paho-mqtt/archive/1.0.0.zip", + "filename": "paho-mqtt-1.0.0.zip", }, { - "version" : "latest", # 最新版本 - "URL" : "https://github.com/RT-Thread-packages/paho-mqtt.git", - "filename" : "paho-mqtt.zip", - "VER_SHA" : "master" # 填入 master + "version": "latest", + "URL": "https://github.com/RT-Thread-packages/paho-mqtt.git", + "filename": "paho-mqtt.zip", + "VER_SHA": "master" } - ] + ] } ```