2012-01-27 18:56:06 +00:00
|
|
|
KiCad installation
|
|
|
|
==================
|
|
|
|
|
|
|
|
The parts of KiCad
|
|
|
|
------------------
|
|
|
|
|
2019-12-03 18:51:59 +00:00
|
|
|
KiCad consists of 3 components:
|
|
|
|
|
|
|
|
kicad - KiCad programs and core files.
|
|
|
|
kicad-doc - Documentation and interactive help (optional package).
|
2021-04-04 06:53:04 +00:00
|
|
|
kicad-library - Schematic symbol, PCB footprint, and 3D model libraries (optional package).
|
2019-12-03 18:51:59 +00:00
|
|
|
|
|
|
|
This repository contains the source code for the main KiCad programs. The documentation
|
|
|
|
and library sources are available at https://gitlab.com/kicad
|
2012-01-27 18:56:06 +00:00
|
|
|
|
|
|
|
|
|
|
|
Installation from binary packages
|
|
|
|
---------------------------------
|
|
|
|
|
2023-03-06 02:07:57 +00:00
|
|
|
Check the KiCad website for packages and installation instructions for
|
|
|
|
all supported platforms: https://kicad.org/download/
|
2012-01-27 18:56:06 +00:00
|
|
|
|
2021-04-04 06:53:04 +00:00
|
|
|
Data files (schematics, boards, libraries) are compatible with all platforms.
|
2012-01-27 18:56:06 +00:00
|
|
|
|
|
|
|
|
2019-12-03 18:51:59 +00:00
|
|
|
Linux install tree
|
2014-10-31 20:44:09 +00:00
|
|
|
-------------------------------------
|
2012-01-27 18:56:06 +00:00
|
|
|
|
2019-12-03 18:51:59 +00:00
|
|
|
The default locations KiCad uses to install its components on Linux are:
|
|
|
|
|
2021-04-04 06:53:04 +00:00
|
|
|
${prefix}/bin - Binaries (executable files).
|
|
|
|
${prefix}/lib/kicad - Shared libraries.
|
|
|
|
${prefix}/share/doc/kicad - Various documentation.
|
|
|
|
${prefix}/share/doc/kicad/help - Interactive help.
|
|
|
|
${prefix}/share/kicad/demos - Sample schematics and printed boards.
|
|
|
|
${prefix}/share/kicad/template - Template projects and sheets.
|
|
|
|
${prefix}/share/kicad/library - Schematic symbol libraries.
|
|
|
|
${prefix}/share/kicad/modules - PCB footprint libraries.
|
|
|
|
${prefix}/share/kicad/3dmodels - 3D component models (.wrl and .step format).
|
|
|
|
${prefix}/share/kicad/resources - Resource files (images, etc).
|
2012-01-27 18:56:06 +00:00
|
|
|
|
2019-12-03 18:51:59 +00:00
|
|
|
Warning:
|
|
|
|
Do not change the KiCad tree, or the location of binary files. Otherwise
|
|
|
|
KiCad may not be able to find some or all of its required files.
|
2014-10-31 20:44:09 +00:00
|
|
|
|
2012-01-27 18:56:06 +00:00
|
|
|
Installation from source code
|
|
|
|
-----------------------------
|
|
|
|
|
2023-03-06 02:07:57 +00:00
|
|
|
Current documentation for building from source can be found at: https://dev-docs.kicad.org/
|
2012-01-27 18:56:06 +00:00
|
|
|
|
|
|
|
|
2021-04-04 06:53:04 +00:00
|
|
|
Important parameters to CMake
|
2012-01-27 18:56:06 +00:00
|
|
|
-----------------------------
|
|
|
|
|
2021-04-04 06:53:04 +00:00
|
|
|
See https://dev-docs.kicad.org/en/build/compile-options/ for a list of all compile options.
|
2014-02-22 23:17:36 +00:00
|
|
|
|
2019-12-03 18:51:59 +00:00
|
|
|
-DCMAKE_BUILD_TYPE=<buildtype>
|
2021-04-04 06:53:04 +00:00
|
|
|
<buildtype> may be one of "Debug", "Release", or "RelWithDebInfo".
|
2012-01-27 18:56:06 +00:00
|
|
|
|
2019-12-03 18:51:59 +00:00
|
|
|
-DCMAKE_INSTALL_PREFIX=<prefix>
|
|
|
|
Default to "/usr/local".
|
2012-01-27 18:56:06 +00:00
|
|
|
|
2019-12-03 18:51:59 +00:00
|
|
|
-DCMAKE_CXX_FLAGS=<some extra flags>
|
2021-04-04 06:53:04 +00:00
|
|
|
Extra flags for the C++ compiler required for your system.
|
2012-01-27 18:56:06 +00:00
|
|
|
|
2019-12-03 18:51:59 +00:00
|
|
|
-DCMAKE_VERBOSE_MAKEFILE=ON
|
|
|
|
When more output is wanted use this cmake parameter or call "make VERBOSE=1".
|