|
1 | | -# SiFli KiCAD Generator |
| 1 | +# SiFli KiCAD Libraries |
2 | 2 |
|
3 | 3 | English | [中文](README-zh.md) |
4 | 4 |
|
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. |
6 | 6 |
|
7 | | -## 安装与使用(用户侧) |
| 7 | +## 📦 Installation |
8 | 8 |
|
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) |
12 | 10 |
|
13 | | -> 用户安装入口保持为 Release ZIP + PCM Install from file。 |
| 11 | +1. Open KiCAD |
| 12 | + |
| 13 | +2. Go to **Tools** → **Package and Content Manager** |
| 14 | +3. Search for "SiFli Library" |
| 15 | +4. Click **Install** |
14 | 16 |
|
15 | | -## 开发依赖 |
| 17 | +### Method 2: Manual Installation |
16 | 18 |
|
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 | + |
| 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 | + |
| 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 | + |
| 26 | +5. Once the package is installed, you will see the SiFli Library listed on the Installed tab. |
| 27 | + |
| 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. |
20 | 29 |
|
21 | | -## 本地生成流程 |
| 30 | +## 🔧 Supported Chips |
22 | 31 |
|
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 | ✅ | ✅ | ✅ | |
28 | 36 |
|
29 | | -关键顺序:**先构建 SiliconSchema,再运行生成器**。 |
| 37 | +**Legend:** |
30 | 38 |
|
31 | | -## 自动发布流程(Tag 驱动) |
| 39 | +- ✅ Available |
| 40 | +- ⚠️ Coming Soon |
| 41 | +- ❌ Not Available |
32 | 42 |
|
33 | | -`/.github/workflows/release.yml` 在 tag push 时自动执行: |
| 43 | +## 📡 Supported Modules |
34 | 44 |
|
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 | ✅ | ✅ | ❌ | |
43 | 48 |
|
44 | | -## 贡献方式 |
| 49 | +**Legend:** |
45 | 50 |
|
46 | | -推荐贡献入口: |
| 51 | +- ✅ Available |
| 52 | +- ⚠️ Coming Soon |
| 53 | +- ❌ Not Available |
47 | 54 |
|
48 | | -- schema/module/template 变更(`SiliconSchema` / `modules` / `templates`) |
49 | | -- 生成器逻辑变更(`src/kicad_generator`) |
| 55 | +## 📚 Documentation |
50 | 56 |
|
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) |
0 commit comments