入门

CMake 是 KiCad 使用的编译配置和 Makefile 生成工具。这是必需的。

官方的源代码仓库托管在 GitLab 上，需要 git 获取最新的源代码。 如果你更喜欢使用 GitHub，有一个官方 KiCad 仓库的只读镜像。 以前的官方托管地点 Launchpad 仍作为镜像活跃。 更改应作为 合并请求 通过 GitLab 提交。 开发团队不会审查在 GitHub 或 Launchpad 上提交的更改，因为这些平台只是镜像。

KiCad 源代码使用 Doxygen 解析 KiCad 源代码文件，并将依赖关系树与源文档一起编译为 HTML。 只有在您要编译 KiCad 文档时才需要 Doxygen。

SWIG 是用于生成 KiCad 的 Python 脚本语言扩展。 如果您不打算编译 KiCad 脚本扩展，则不需要 SWIG。

wxWidgets 是 KiCad 使用的图形用户界面 (GUI) 库。 当前的最低版本是 3.0.0。 但是，应该尽可能使用 3.0.2，因为以前版本中的一些已知错误可能会在某些平台上导致问题。 请注意，在从源代码编译 wxWidget 之前，还必须应用一些特定于平台的补丁。 这些补丁程序可以在 KiCad 源代码的 patches 文件夹 中找到。 这些补丁由应该应用它们的 wxWidgets 版本和平台名称命名。wxWidget 必须使用 --with-opengl 选项编译。 如果您的系统上安装了 wxWidgets 的打包版本，请验证它是否使用此选项编译。

仅当您打算使用系统安装的 Boost 版本而不是默认的内部编译版本编译 KiCad 时，才需要 Boost C++ 库。 如果使用系统安装的 Boost 版本，则需要 1.56 或更高版本。请注意，编译有效的 Boost 库需要一些特定于平台的补丁。 这些补丁程序可以在 KiCad 源代码的 patches 文件夹 中找到。 这些补丁程序按应应用它们的平台名称命名。

OpenGL Extension Wrangler 是 KiCad 图形抽象库 [GAL] 使用的 OpenGLhelper 库， 在编译 KiCad 时总是需要的。

KiCad 使用 ZLib 开发库来处理压缩的 3D 模型 (.stpz 和 .wrz 文件)， 并且在编译 KiCad 时始终需要该开发库。

OpenGL Mathematics 库 是由 KiCad 图形抽象库 [GAL] 使用的 OpenGLHelper 库， 并且总是编译 KiCad 所必需的。

OpenGL Utility Toolkit 是 KiCad 图形抽象库 [GAL] 使用的 OpenGL 辅助程序库，在编译 KiCad 时始终需要它。

Cairo 不可用时，OpenGL2D 图形库用作备用渲染画布，并且始终需要它来编译 KiCad。

Python 编程语言用于为 KiCad 提供脚本支持。 除非禁用 [KiCad 脚本](#kicad_script) 编译配置选项，否则需要安装它。

wxPython 库用于为 pcbnew 提供脚本控制台。 除非禁用 [wxPython脚本](#wxpython_script) 编译配置选项，否则需要安装它。 在支持 wxPython 的情况下编译 KiCad 时，请确保 wxWidgets 库的版本与系统上安装的 wxPython 版本相同。 已知不匹配的版本会导致运行时问题。

Curl 多协议文件传输库 用于为 [GitHub][] 插件提供安全的互联网文件传输访问。 除非禁用 GitHub Plug 编译选项，否则需要安装此库。

Open CASCSADE 技术 (OCC) 用于提供对加载和保存 3D 模型文件格式(如 STEP)的支持。 除非禁用 OCC 编译选项，否则需要安装此库。使用选项 BUILD_MODULE_DRAW=OFF 编译 OCC 时，使编译更加容易

KICAD_SCRIPTING 选项用于将 Python 脚本支持编译到 Pcbnew 中。 默认情况下，此选项处于启用状态，并且在禁用时将禁用所有其他 KICAD_SCRIPTING_* 选项。

KICAD_SCRIPTING_PYTHON3 选项用于启用使用 Python 3 而不是 Python 2 进行脚本支持。 默认情况下，此选项处于禁用状态，仅当启用 [KICAD_SCRIPTING](#scripting_opt) 时才相关。

KICAD_SCRIPTING_MODULES 选项用于支持编译和安装 KiCad 提供的 Python 模块。 默认情况下，此选项处于启用状态，但如果禁用 [KICAD_SCRIPTING](#scripting_opt)，则此选项将被禁用。

KICAD_SCRIPTING_WXPYTHON 选项用于将 wxPython 接口编译到 Pcbnew 中，包括 wxPython 控制台。 默认情况下，此选项处于启用状态，但如果禁用 [KICAD_SCRIPTING](#scripting_opt)，则此选项将被禁用。

KICAD_SCRIPTING_WXPYTHON_PHOENIX 选项用于使用新的 Phoenix 绑定(而不是旧的绑定)编译 wxPython 接口。 默认情况下该选项处于禁用状态，启用该选项需要启用 [KICAD_SCRIPTING](#scripting_opt)。

KICAD_SCRIPTING_ACTION_MENU 选项允许将 Python 脚本直接添加到 Pcbnew 菜单。 默认情况下，此选项处于启用状态，但如果禁用 [KICAD_SCRIPTING](#scripting_opt)，则此选项将被禁用。 请注意，此选项是高度实验性的，如果 Python 脚本在 Pcbnew 中创建无效的对象状态，可能会导致 Pcbnew 崩溃。

KICAD_SPICE 选项用于控制是否为 EesChema 编译 Spice 仿真器接口。启用此选项时，它要求 [ngspice][] 作为共享库可用。 默认情况下，此选项处于启用状态。

KICAD_USE_OCC 用于 3D 查看器插件以支持 STEP 和 IGES 3D 模型。 此选项启用与 OpenCascade (OCC) 相关的编译工具和插件。 启用时，它要求 [libocct][] 可用。 默认情况下，此选项处于启用状态。

KICAD_USE_EGL 选项将 OpenGL 后端从使用 X11 绑定切换到 Wayland EGL 绑定。 只有在运行 wxWidgets 3.1.5+ 和 wxGLCanvas 的 EGL 后端时，该选项才与 Linux 相关(这是默认选项，但可以在 wxWidgets 编译中禁用)。

默认情况下，设置 KICAD_USE_EGL 将使用静态链接到 KiCad 的 Glew 库的树内版本(使用在 EGL 画布上运行所需的附加标志进行编译)。 如果 Glew 的系统版本支持 EGL (必须使用 GLEW_EGL 标志进行编译)，则可以通过将 KICAD_USE_Bundled_Glew 设置为 OFF 来使用它。

KICAD_WIN32_DPI_AWARE 选项使 KiCad 的 Windows 清单文件使用支持 DPI 的版本， 该版本告诉 Windows KiCad 希望每个监视器 V2 识别 DPI (需要 Windows 10 版本 1607 和更高版本)。

KiCad 可以编译为支持多个功能，以帮助捕获和调试运行时内存问题

KiCad 源代码包括一些演示和示例来展示该程序。您可以使用 KICAD_INSTALL_DEMOS 选项选择是否安装它们。 您还可以使用 KICAD_DEMOS 变量选择它们的安装位置。在 Linux 上，演示程序安装在。 默认情况下为 $prefix/share/kicad/demos。

KICAD_BUILD_QA_TESTS 选项允许编译用于质量保证的单元测试二进制文件，作为默认编译的一部分。 默认情况下，此选项处于启用状态。

如果禁用此选项，仍可以通过手动指定目标来编译 QA 二进制文件。 以 make 为例：

有关测试 KiCad 的更多信息，请参阅 [本页](testing.md)。

当 git 可用时，KiCad 版本字符串由 git Describe—​dirty 的输出定义， 或者由 CMakeModules/KiCadVersion.cmake 中定义的版本字符串定义， 并在前者后面附加 KICAD_VERSION_EXTRA 的值。如果未定义 KICAD_VERSION_EXTRA 变量， 则不会将其附加到版本字符串。如果定义了 KICAD_VERSION_EXTRA 变量， 则会将其与前导 '-' 一起追加到完整版本字符串，如下所示：

生成脚本自动从 [git][] 仓库中创建版本字符串信息。 有关资料如下：

KiCad 默认配置目录为 kicad。在 Linux 上位于 ~/.config/kicad， 在 MSW 上位于 C：\Documents and Settings\用户名\Application Data\kicad， 在 MacOS 上位于 ~/Library/Preferences/kicad。 如果安装包愿意，它可以指定一个替代配置名称，而不是 kicad。 这对于对配置参数进行版本化并且允许同时使用例如 kicad5 和 kicad6 而不丢失配置数据可能是有用的。

这是通过在编译时指定 KICAD_CONFIG_DIR 字符串来设置的。

从 GNU GCC 版本 5 开始，使用下载、修补和编译 Boost 1.54 的默认配置将导致 KiCad构 建失败。 因此，必须用更新版本的 Boost 来编译 KiCad。如果您系统安装了 Boost 1.56 或更高版本，则您的工作非常简单。 如果您的系统未安装 Boost 1.56 或更高版本，则必须从源代码下载和 编译 Boost。 如果您使用 MinGW 在 Windows 上编译 Boost，则必须应用 KiCad 源 patches 文件夹中的 Boost 补丁。