Skip to content

Commit

Permalink
docs: Fix example and add description of current structure
Browse files Browse the repository at this point in the history
  • Loading branch information
taoky committed May 23, 2024
1 parent 46d9c33 commit f219545
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ urlbase = /

!include includes/os/archlinux.ini
!include includes/app/vlc.ini
!include includes/font/google_fonts.ini
!include includes/font/adobe_source.ini
!include includes/github/rust-analyzer.ini
```

`!include` 后的路径如果是相对路径,则是相对于该 ini 文件的路径。
Expand Down Expand Up @@ -116,6 +117,15 @@ python3 utils/check-config.py includes/

如果参数是目录,则脚本会遍历目录下所有的 ini 文件,逐个尝试进行解析和检查;如果是单个文件,则只检查该文件。

### 公用配置目录结构

[`includes`](./includes/) 目录存储公用的配置文件,目前分为四类:

- app:软件安装包对应配置
- font:字体文件对应配置
- github:[GitHub Release](https://mirrorz.org/list/github-release) 对应配置,文件名为对应仓库的所有者
- os:操作系统镜像对应配置

## 使用

[genisolist.py](./genisolist.py) 为参考实现,用于从配置与本地文件系统输出以上的 JSON 格式。可以使用其 `process_ini()``gen_from_sections()` 用于整合镜像站点的其他设施,也可以直接运行,例如下:
Expand Down Expand Up @@ -176,9 +186,15 @@ urlbase = /
!include mirrorz-genisolist/includes/distro.ini
!include mirrorz-genisolist/includes/os/archlinux.ini
!include mirrorz-genisolist/includes/app/vlc.ini
!include mirrorz-genisolist/includes/font/google_fonts.ini
!include mirrorz-genisolist/includes/font/adobe_source.ini
!include mirrorz-genisolist/includes/github/rust-analyzer.ini
# 导入镜像站自己维护的子配置
!include genisolist/os/example.ini
# 镜像站也可以直接写 section
[some-distro]
distro = Some Distro
# ...
```

3 changes: 2 additions & 1 deletion example.ini
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ urlbase = /
!include includes/distro.ini
!include includes/os/archlinux.ini
!include includes/app/vlc.ini
!include includes/font/google_fonts.ini
!include includes/font/adobe_source.ini
!include includes/github/rust-analyzer.ini

0 comments on commit f219545

Please sign in to comment.