Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
Sunrisepeak committed Dec 21, 2024
1 parent 5cbbc14 commit 1fbb3dd
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ software, library, environment install/config ...

---

## 添加一个XPackage包文件到索引仓库
## 如何添加一个XPackage包文件到索引仓库?

- 第一步: 创建个[Add XPackage](https://github.com/d2learn/xim-pkgindex/issues/new/choose) & 填写基础信息
- 第二步: 复制一份[包模板文件](docs/xpackage-template.lua)
Expand Down Expand Up @@ -35,4 +35,4 @@ software, library, environment install/config ...
## 社区&交流

- [论坛](https://forum.d2learn.org/category/9/xlings)
- [交流群]: 1006282943
- 交流群(Q): 1006282943
11 changes: 6 additions & 5 deletions docs/add-xpackage.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

**基础信息描述部分**

基础信息部分主要是要来描述和记录这个包的相关信息的。这些信息会在安装的时候进行显示, 但是他们不会实质的影响安装的过程。但为了包的完整度应该尽可能的填写相关字段(至少包含`name``description``type``keywords`)。具体格式如下:
基础信息部分主要是要来描述和记录这个包的相关信息的。**这些信息会在安装的时候进行显示, 但是他们不会实质的影响安装的过程。**但为了包的完整度应该尽可能的填写相关字段(至少包含`name``description``type``keywords`)。具体格式如下:

```lua
package = {
Expand Down Expand Up @@ -50,9 +50,9 @@ package = {

**平台&依赖&资源描述部分 - xpm**

xpm字段描述了这个包支持的具体的平台, 以及每个平台上安装这个包需要的依赖和网络资源。这个部分会实质性的影响安装过程且没有描述的平台/系统和版本将不会添加到用户的本地索引数据库中, 即不可查询和安装
xpm字段描述了这个包支持的具体的平台, 以及每个平台上安装这个包需要的依赖和网络资源。这个部分会实质性的影响安装过程且**没有描述的平台/系统和版本将不会添加到用户的本地索引数据库中, 即不可查询和安装**

- 系统名是xpm的key表示要支持的系统/平台
- 系统名是xpm的中的key, 表示要支持的系统/平台
- 系统key对应的值包含:
- deps是可选项, 用来描述这个包在对应平台下需要的依赖(这些依赖需要已经在索引仓库中)
- 版本项也是kv结构 `["key"] = {"url", "sha256"}`
Expand Down Expand Up @@ -80,6 +80,7 @@ package = {
```

> **注:**
>
> 1.latest版本一般会使用ref引用到一个具体的版本上
>
> 2.如果没有网络资源时(例如是auto-config包)可以填写一个空列表。如: `[1.0.1] = { },`
Expand All @@ -103,7 +104,7 @@ end

install和uninstall主要是对应的安装和卸载, 可以使用lua代码对资源文件进行操作。通常使用os.exec函数等同与命令行

注: 所有的hooks都运行在和所下载资源的同级目录
> **注:** 所有的hooks都运行在和所下载资源的同级目录
## 第三步: 修改文件名和包内容 - mdbook包文件示例

Expand Down Expand Up @@ -204,7 +205,7 @@ function uninstall()
end
```

注: 更多复杂的包文件实现, 可以参考[索引仓库](https://github.com/d2learn/xim-pkgindex)中的其他包文件
> **注:** 更多复杂的包文件实现, 可以参考[索引仓库](https://github.com/d2learn/xim-pkgindex)中的其他包文件
## 第四步: 对包内容进行测试

Expand Down

0 comments on commit 1fbb3dd

Please sign in to comment.