You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

163 lines
5.4 KiB

  1. KiCad installation
  2. ==================
  3. The parts of KiCad
  4. ------------------
  5. KiCad consists of 3 components:
  6. kicad - KiCad programs and core files.
  7. kicad-doc - Documentation and interactive help (optional package).
  8. kicad-library - Schematic symbol, PCB footprint, and 3D model libraries (optional package).
  9. This repository contains the source code for the main KiCad programs. The documentation
  10. and library sources are available at https://gitlab.com/kicad
  11. Installation from binary packages
  12. ---------------------------------
  13. Compiled KiCad binaries exist for Windows (8.1, 10), macOS (10.14+), and several
  14. Linux distributions (Fedora, Debian, Ubuntu, Arch). These are available from the
  15. main KiCad website: https://kicad.org/download/
  16. Data files (schematics, boards, libraries) are compatible with all platforms.
  17. Installation from binary packages for Windows
  18. ---------------------------------------------
  19. KiCad can be installed anywhere on the system as long as the user has write privileges.
  20. Pre-made installers are available on the KiCad website: https://kicad.org/download/windows/
  21. Installation from binary packages for Linux
  22. -------------------------------------------
  23. KiCad comes packaged on many Linux platforms including Debian, Fedora, Ubuntu and Arch,
  24. and is available in their respective package repositories. More information can be found on
  25. the platform's page at https://kicad.org/download/
  26. Linux install tree
  27. -------------------------------------
  28. The default locations KiCad uses to install its components on Linux are:
  29. ${prefix}/bin - Binaries (executable files).
  30. ${prefix}/lib/kicad - Shared libraries.
  31. ${prefix}/share/doc/kicad - Various documentation.
  32. ${prefix}/share/doc/kicad/help - Interactive help.
  33. ${prefix}/share/kicad/demos - Sample schematics and printed boards.
  34. ${prefix}/share/kicad/template - Template projects and sheets.
  35. ${prefix}/share/kicad/library - Schematic symbol libraries.
  36. ${prefix}/share/kicad/modules - PCB footprint libraries.
  37. ${prefix}/share/kicad/3dmodels - 3D component models (.wrl and .step format).
  38. ${prefix}/share/kicad/resources - Resource files (images, etc).
  39. Warning:
  40. Do not change the KiCad tree, or the location of binary files. Otherwise
  41. KiCad may not be able to find some or all of its required files.
  42. macOS KiCad tree
  43. ----------------
  44. System wide files
  45. /Library/Application Support/kicad/help
  46. /Library/Application Support/kicad/template
  47. /Library/Application Support/kicad/library
  48. /Library/Application Support/kicad/modules
  49. /Library/Application Support/kicad/3dmodels
  50. User files can be the same as the system wide files but only inside the user's home directory.
  51. $HOME/Library/Application Support/kicad
  52. Warning:
  53. These paths are hardcoded into KiCad, if you put them somewhere else KiCad will not find
  54. them when a new project is created.
  55. Installation from source code
  56. -----------------------------
  57. Currently the only supported compilers are GCC on Linux and Windows and Clang on macOS.
  58. Some dependencies must be satisfied for the correct installation of KiCad:
  59. wxWidgets >= 3.0.0 http://www.wxwidgets.org/
  60. CMake >= 3.10.0 https://www.cmake.org/
  61. Boost C++ Libraries >= 1.59 https://www.boost.org/
  62. OpenGL >= 2.1
  63. Linux: Mesa 3D Graphics Library http://www.mesa3d.org/
  64. Windows: built-in
  65. Zlib Compression Library http://www.zlib.net/
  66. cairo >= 1.12 http://cairographics.org/
  67. GLEW http://glew.sourceforge.net/
  68. libcurl http://curl.haxx.se/
  69. OpenMP (optional) http://openmp.org/
  70. GLM >= 9.5.4 http://glm.g-truc.net/
  71. pkg-config http://pkgconfig.freedesktop.org/
  72. Doxygen (optional) http://www.doxygen.nl
  73. Python >= 2.6 (optional) https://python.org/
  74. wxPython (optional) http://www.wxpython.org/
  75. SWIG >= 3.0 (optional) http://swig.org/
  76. libngspice (optional) http://ngspice.sourceforge.net/
  77. One of:
  78. OCE >= 0.18 (optional) https://github.com/tpaviot/oce
  79. OCC >= 6.9.0 (optiona) https://www.opencascade.com/content/latest-release
  80. Complete documentation for building from source can be found at: https://dev-docs.kicad.org/
  81. Important parameters to CMake
  82. -----------------------------
  83. See https://dev-docs.kicad.org/en/build/compile-options/ for a list of all compile options.
  84. -DCMAKE_BUILD_TYPE=<buildtype>
  85. <buildtype> may be one of "Debug", "Release", or "RelWithDebInfo".
  86. -DCMAKE_INSTALL_PREFIX=<prefix>
  87. Default to "/usr/local".
  88. -DwxWidgets_ROOT_DIR=<wxInstallDir>
  89. Required for Windows platform.
  90. -DwxWidgets_USE_DEBUG=ON
  91. Can be used only with -DCMAKE_BUILD_TYPE=Debug
  92. -DCMAKE_CXX_FLAGS=<some extra flags>
  93. Extra flags for the C++ compiler required for your system.
  94. -DCMAKE_VERBOSE_MAKEFILE=ON
  95. When more output is wanted use this cmake parameter or call "make VERBOSE=1".
  96. Extra CFLAGS and linker flags
  97. -----------------------------
  98. If you require extra flags for compiler and linker you may give them via
  99. environment variables
  100. "CXXFLAGS" (c++ compiler)
  101. "LDFLAGS" (for linker)
  102. "CFLAGS" (for c-compiler, not needed in kdesvn build)