Skip to content

Commit 82296be

Browse files
committed
docs: restore user-facing READMEs and add maintainer guide
Restore README.md and README-zh.md to the back-main user installation format, and move release pipeline maintenance details into docs/maintainers.md for maintainers.
1 parent 4280b3c commit 82296be

File tree

3 files changed

+175
-64
lines changed

3 files changed

+175
-64
lines changed

README-zh.md

Lines changed: 55 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,74 @@
22

33
[English](README.md) | 中文
44

5-
用于从 SiliconSchema 构建产物自动生成 SiFli SoC/Module 的 KiCad symbols 与 footprints,并通过 GitHub Release 发布可直接在 KiCad PCM 中安装的 ZIP 包
5+
SiFli SoC 和模组的官方 KiCAD 符号、封装和 3D 模型库
66

7-
## 📦 安装方法(用户侧)
7+
## 📦 安装方法
88

9-
1.[Releases](https://github.com/OpenSiFli/kicad-libraries/releases) 下载最新 `sifli-kicad-libraries-<tag>.zip`
10-
2. 打开 KiCad → **工具****拓展内容管理器**
11-
3. 选择 **从文件安装...** 并选中 ZIP。
9+
### 方法一:KiCAD 拓展内容管理器(暂不支持)
1210

13-
> 用户安装入口保持为 Release ZIP + PCM Install from file。
11+
1. 打开 KiCAD
12+
![PCM-home](./docs/image-cn/PCM-home.png)
13+
2. 转到 **工具****拓展内容管理器**
14+
3. 搜索 "SiFli Library"
15+
4. 点击 **安装**
1416

15-
## 🔧 开发环境
17+
### 方法二:手动安装
1618

17-
- Python >= 3.13
18-
- `uv`
19-
- 已拉取 submodule:`SiliconSchema``kicad-footprint-generator``kicad-library-utils`
19+
1.[Releases](https://github.com/OpenSiFli/kicad-libraries/releases) 下载最新版本
20+
2. 转到 **工具****拓展内容管理器**
21+
![PCM-home](./docs/image-cn/PCM-home.png)
22+
3. PCM 窗口将显示可用的插件、库和颜色主题列表。您可以浏览分类或使用搜索栏查找特定包。
23+
![PCM](./docs/image-cn/PCM.png)
24+
4. 要使用最新版本的 ZIP 文件手动安装库,您需要从"从文件安装..."中选择文件
25+
![PCM-install](./docs/image-cn/install-from-file.png)
26+
5. 安装包后,您将在"已安装"选项卡中看到 SiFli Library。
27+
![PCM-SiFli](./docs/image-cn/SiFli.png)
28+
6. 现在您可以使用该库了。请注意,该库将在符号和封装中列为 PCM_SiFli。
2029

21-
## 🏗️ 本地生成
30+
## 🔧 支持的芯片
2231

23-
```bash
24-
uv sync --frozen
25-
uv run --directory SiliconSchema build-schema
26-
uv run kicad-generator --output-dir build
27-
```
32+
| 型号 | 封装名称 | 符号 | 封装 | 3D 模型 |
33+
|-------------|-------------|--------|-----------|----------|
34+
| SF32LB52XUx | QFN68 ||||
35+
| SF32LB52xUx | QFN68 ||||
2836

29-
关键顺序:**必须先构建 SiliconSchema,再运行生成器**
37+
**图例:**
3038

31-
## 🚀 自动发布(Tag 驱动)
39+
- ✅ 可用
40+
- ⚠️ 即将推出
41+
- ❌ 不可用
3242

33-
推送 tag 后,`/.github/workflows/release.yml` 自动执行:
43+
## 📡 支持的模组
3444

35-
1. checkout + recursive submodules
36-
2. 安装 `uv`
37-
3. `uv sync --frozen`
38-
4. `uv run --directory SiliconSchema build-schema`
39-
5. `uv run kicad-generator --output-dir build`
40-
6. 整理发布目录(`symbols/``footprints/``resources/``metadata.json`
41-
7. `uv run scripts/build_release.py --source-dir release-staging --tag <tag>`
42-
8. 上传 ZIP 与 `metadata-upstream.json` 到 GitHub Release
45+
| 型号 | 符号 | 封装 | 3D 模型 |
46+
|-------------|--------|-----------|----------|
47+
| SF32LB52-MOD-1 ||||
48+
49+
**图例:**
50+
51+
- ✅ 可用
52+
- ⚠️ 即将推出
53+
- ❌ 不可用
54+
55+
## 📚 文档资料
56+
57+
- [SiFli 硬件设计指南](https://wiki.sifli.com/hardware/index.html)
58+
- [SiFli 官方网站](https://www.sifli.com/)
59+
- [维护者文档](docs/maintainers.md)
4360

4461
## 🤝 贡献
4562

46-
推荐贡献入口:
63+
欢迎贡献!请随时提交 Pull Request。
64+
65+
## 📄 许可证
66+
67+
此库采用 [CC-BY-SA-4.0](LICENSE) 许可证。
68+
69+
## 📞 技术支持
4770

48-
- schema / module / template(`SiliconSchema``modules``templates`
49-
- 生成器代码(`src/kicad_generator`
71+
如需技术支持和咨询:
5072

51-
发布产物以 CI 自动生成为主,不再依赖手工维护。
73+
- 访问 [SiFli Wiki](https://wiki.sifli.com/)
74+
- 在此仓库中创建 issue
75+
- 联系:[GitHub Issues](https://github.com/OpenSiFli/kicad-libraries/issues)

README.md

Lines changed: 57 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,75 @@
1-
# SiFli KiCAD Generator
1+
# SiFli KiCAD Libraries
22

33
English | [中文](README-zh.md)
44

5-
用于从 SiliconSchema 构建产物自动生成 SiFli SoC/Module 的 KiCad symbols 与 footprints,并通过 GitHub Release 发布可直接在 KiCad PCM 中安装的 ZIP 包。
5+
Official KiCAD symbol, footprint and 3D model libraries for SiFli SoC and modules.
66

7-
## 安装与使用(用户侧)
7+
## 📦 Installation
88

9-
1.[Releases](https://github.com/OpenSiFli/kicad-libraries/releases) 下载最新 `sifli-kicad-libraries-<tag>.zip`
10-
2. 打开 KiCad → **Tools****Package and Content Manager**
11-
3. 选择 **Install from file...** 并选中该 ZIP。
9+
### Method 1: KiCAD Package and Content Manager (Not yet supported)
1210

13-
> 用户安装入口保持为 Release ZIP + PCM Install from file。
11+
1. Open KiCAD
12+
![PCM-home](./docs/image-en/PCM-home.png)
13+
2. Go to **Tools****Package and Content Manager**
14+
3. Search for "SiFli Library"
15+
4. Click **Install**
1416

15-
## 开发依赖
17+
### Method 2: Manual Installation
1618

17-
- Python >= 3.13
18-
- [uv](https://docs.astral.sh/uv/)
19-
- 已初始化 submodules(`SiliconSchema``kicad-footprint-generator``kicad-library-utils`
19+
1. Download the latest release from [Releases](https://github.com/OpenSiFli/kicad-libraries/releases)
20+
2. Go to **Tools****Package and Content Manager**
21+
![PCM-home](./docs/image-en/PCM-home.png)
22+
3. The PCM window will display a list of available plugins, libraries, and color themes. You can browse through the categories or use the search bar to find a specific package.
23+
![PCM](./docs/image-en/PCM.png)
24+
4. To install the library manually using the ZIP file from the latest release, you need to select the file from "Install from file..."
25+
![PCM-install](./docs/image-en/install-from-file.png)
26+
5. Once the package is installed, you will see the SiFli Library listed on the Installed tab.
27+
![PCM-SiFli](./docs/image-en/SiFli.png)
28+
6. Now you are ready to use the library. Note that the library will be listed as PCM_SiFli in the Symbol and Footprint.
2029

21-
## 本地生成流程
30+
## 🔧 Supported Chips
2231

23-
```bash
24-
uv sync --frozen
25-
uv run --directory SiliconSchema build-schema
26-
uv run kicad-generator --output-dir build
27-
```
32+
| Part Number | Package Name | Symbol | Footprint | 3D Model |
33+
|-------------|-------------|--------|-----------|----------|
34+
| SF32LB52XUx | QFN68 ||||
35+
| SF32LB52xUx | QFN68 ||||
2836

29-
关键顺序:**先构建 SiliconSchema,再运行生成器**
37+
**Legend:**
3038

31-
## 自动发布流程(Tag 驱动)
39+
- ✅ Available
40+
- ⚠️ Coming Soon
41+
- ❌ Not Available
3242

33-
`/.github/workflows/release.yml` 在 tag push 时自动执行:
43+
## 📡 Supported Modules
3444

35-
1. `actions/checkout` + `submodules: recursive`
36-
2. 安装 `uv`
37-
3. `uv sync --frozen`
38-
4. `uv run --directory SiliconSchema build-schema`
39-
5. `uv run kicad-generator --output-dir build`
40-
6. 将生成结果整理为发布结构(`symbols/``footprints/``resources/``metadata.json`
41-
7. `uv run scripts/build_release.py --source-dir release-staging --tag <tag>`
42-
8. 通过 `ncipollo/release-action` 上传 ZIP 和 `metadata-upstream.json`
45+
| Part Number | Symbol | Footprint | 3D Model |
46+
|-------------|--------|-----------|----------|
47+
| SF32LB52-MOD-1 ||||
4348

44-
## 贡献方式
49+
**Legend:**
4550

46-
推荐贡献入口:
51+
- ✅ Available
52+
- ⚠️ Coming Soon
53+
- ❌ Not Available
4754

48-
- schema/module/template 变更(`SiliconSchema` / `modules` / `templates`
49-
- 生成器逻辑变更(`src/kicad_generator`
55+
## 📚 Documentation
5056

51-
发布产物不再以手工维护为主,而是由 CI 自动生成并随 tag 发布。
57+
- [SiFli Hardware Design Guidelines](https://wiki.sifli.com/hardware/index.html)
58+
- [SiFli Official Website](https://www.sifli.com/)
59+
- [Maintainer Guide](docs/maintainers.md)
60+
61+
## 🤝 Contributing
62+
63+
Contributions are welcome! Please feel free to submit a Pull Request.
64+
65+
## 📄 License
66+
67+
This library is licensed under [CC-BY-SA-4.0](LICENSE).
68+
69+
## 📞 Support
70+
71+
For technical support and questions:
72+
73+
- Visit [SiFli Wiki](https://wiki.sifli.com/)
74+
- Create an issue in this repository
75+
- Contact: [GitHub Issues](https://github.com/OpenSiFli/kicad-libraries/issues)

docs/maintainers.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Maintainer Guide
2+
3+
本指南面向仓库维护者,说明生成与发布链路。用户安装方式请以 `README.md` / `README-zh.md` 为准。
4+
5+
## Prerequisites
6+
7+
- Python >= 3.13
8+
- [uv](https://docs.astral.sh/uv/)
9+
- submodules initialized (`SiliconSchema`, `kicad-footprint-generator`, `kicad-library-utils`)
10+
11+
## Local Generation Workflow
12+
13+
关键顺序:**先构建 SiliconSchema,再运行本仓库生成器**
14+
15+
```bash
16+
uv sync --frozen
17+
uv run --directory SiliconSchema build-schema
18+
uv run kicad-generator --output-dir build
19+
```
20+
21+
## Release Packaging Workflow
22+
23+
发布结构由 CI staging 目录整理而来,包含:
24+
25+
- `symbols/MCU_SiFli.kicad_sym`
26+
- `footprints/*.pretty/*.kicad_mod`
27+
- `resources/*`
28+
- `metadata.json`
29+
30+
打包脚本:
31+
32+
```bash
33+
uv run scripts/build_release.py --source-dir release-staging --tag <tag>
34+
```
35+
36+
输出包括:
37+
38+
- `sifli-kicad-libraries-<tag>.zip`
39+
- `metadata-upstream.json`
40+
- `package_path.txt`
41+
- `metadata_path.txt`
42+
- `package_size.txt`
43+
- `install_size.txt`
44+
- `package_sha256.txt`
45+
46+
## GitHub Actions Release Workflow
47+
48+
`/.github/workflows/release.yml` 在 tag push 时执行,固定顺序:
49+
50+
1. `actions/checkout@v4` with `submodules: recursive`
51+
2. `astral-sh/setup-uv@v6`
52+
3. `uv sync --frozen`
53+
4. `uv run --directory SiliconSchema build-schema`
54+
5. `uv run kicad-generator --output-dir build`
55+
6. staging 发布目录整理
56+
7. `uv run scripts/build_release.py --source-dir release-staging --tag <tag>`
57+
8. `ncipollo/release-action` 上传 ZIP 与 `metadata-upstream.json`
58+
59+
## Notes
60+
61+
- CI 与本地都必须使用 `uv` 运行命令,不使用裸 `python`
62+
- 只要涉及 schema 变更,请优先验证 `SiliconSchema/out/<series>/series.yaml` 是否已刷新。
63+
- 发布产物应由 CI 生成并上传,不建议手工维护 release ZIP。

0 commit comments

Comments
 (0)