marbastlib 项目使用教程

marbastlib 项目使用教程

marbastlib A library collecting MX and Choc style footprints, as well as various other parts used to design custom keyboards 项目地址: https://gitcode.com/gh_mirrors/ma/marbastlib

1. 项目目录结构及介绍

marbastlib 是一个用于设计自定义键盘的库，收集了 MX 和 Choc 风格 footprints 以及其他各种用于设计键盘的部件。以下是项目的目录结构及其介绍：

marbastlib/
├── 3dmodels/
│   └── ...  # 3D 模型文件
├── PCM/
│   └── ...  # PCM 文件
├── footprints/
│   └── ...  # 各种 footprints 文件
├── libmanagement/
│   └── ...  # 库管理文件
├── resources/
│   └── ...  # 资源文件
├── symbols/
│   └── ...  # 符号文件
├── .gitignore
├── LICENSE
├── README.md
└── resources.zip

目录介绍

• 3dmodels/: 包含项目的 3D 模型文件。
• PCM/: 包含 PCM 文件，用于 KiCad 的插件和内容管理器。
• footprints/: 包含各种 footprints 文件，用于设计键盘的物理布局。
• libmanagement/: 包含库管理文件，用于管理项目的库。
• resources/: 包含项目的资源文件。
• symbols/: 包含符号文件，用于设计键盘的电路图。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的许可证文件，采用 CERN-OHL-P-2.0 许可证。
• README.md: 项目的说明文件，包含项目的介绍、安装方法、使用说明等。
• resources.zip: 包含项目的资源文件，可能需要解压使用。

2. 项目的启动文件介绍

marbastlib 项目没有传统的“启动文件”，因为它是一个库，而不是一个可执行的应用程序。项目的核心功能是通过 KiCad 的插件和内容管理器（PCM）来安装和使用。

安装方法

1. 打开 KiCad 的“插件和内容管理器”（PCM）。
2. 点击“管理”。
3. 添加一个新的条目，使用加号按钮，并粘贴以下 URL：

   https://raw.githubusercontent.com/ebastler/ebastler-KiCad-repository/main/repository.json
   

4. 从下拉菜单中选择“ebastler KiCad repository”，然后安装 marbastlib。

3. 项目的配置文件介绍

marbastlib 项目没有传统的“配置文件”，因为它是一个库，而不是一个需要配置的应用程序。项目的配置主要通过 KiCad 的插件和内容管理器（PCM）来完成。

使用注意事项

• 请确保在使用任何 footprint 时，不要将其与来自其他库的符号混合使用，因为引脚编号约定可能不同，这可能导致 PCB 损坏。
• 对于实验性的 footprints（位于 marbastlib-xp-* 库中），请特别小心，并在成功测试后向项目报告，以便将其移入常规库中。

通过以上步骤，您可以成功安装和使用 marbastlib 库来设计自定义键盘。

marbastlib A library collecting MX and Choc style footprints, as well as various other parts used to design custom keyboards 项目地址: https://gitcode.com/gh_mirrors/ma/marbastlib