Go to file
Seth Hillbrand 6a73c7ffb3 Remove cover type in link holder 2024-04-21 11:11:48 -07:00
.githooks Fix pre-commit symlink 2023-05-12 16:10:18 +03:00
.github Update GitHub funding link 2023-10-18 09:40:34 -07:00
.gitlab Add api to the CI tests 2024-04-03 07:56:43 -04:00
3d-viewer Disable lazy-loading of 3D models on macOS 2024-04-07 08:20:34 -04:00
api Remove LIB types from API for now 2024-04-13 15:03:34 -04:00
bitmap2component Strip out no longer needed links on the top executables 2024-04-14 07:52:02 -04:00
cmake Disable a MSVC warning seen in protobuf generated code 2024-04-03 18:10:21 -04:00
common Fix warnings. 2024-04-20 20:09:17 +03:00
cvpcb Static cast some more enum usage 2024-04-13 15:15:39 -04:00
demos Demos update 2024-02-09 20:31:32 +01:00
doxygen Use newer docker image for doxygen 2024-04-07 00:52:34 +00:00
eeschema Do not show click to start wire cursor for hidden pins. 2024-04-21 10:54:52 -04:00
gerbview Strip out no longer needed links on the top executables 2024-04-14 07:52:02 -04:00
include RIP LIB_PIN. 2024-04-20 12:10:31 +01:00
kicad ADDED: Fuse Shapes option for STEP/BREP/GLTF export. 2024-04-19 03:43:26 +03:00
libs Minor net navigator improvements. 2024-04-17 14:31:50 -04:00
pagelayout_editor Strip out no longer needed links on the top executables 2024-04-14 07:52:02 -04:00
pcb_calculator Strip out no longer needed links on the top executables 2024-04-14 07:52:02 -04:00
pcbnew Remove cover type in link holder 2024-04-21 11:11:48 -07:00
plugins Show actual IO_ERROR message at VRML import. 2024-04-11 11:38:40 +00:00
qa RIP LIB_PIN. 2024-04-20 12:10:31 +01:00
resources Fix windows icons. Need 256 not 128px 2024-03-22 11:09:06 -07:00
scripting Add QA tests and expand serialization for API 2024-04-02 19:51:18 -04:00
signing New macOS installation scripts 2023-09-19 17:23:30 -04:00
thirdparty Partially update the json validator 2024-04-12 20:00:12 -04:00
tools Push library management into IO_BASE 2023-12-27 01:21:53 +00:00
translation Update translations 2024-04-14 14:22:59 -07:00
utils Fix accidentally backed-out change to idftools for macOS 2023-09-20 09:52:25 -04:00
.clang-tidy Add more checks in .clang-tidy 2021-12-01 00:47:22 +01:00
.gitattributes Force script line endings 2024-01-16 16:03:43 -05:00
.gitignore Add initial CMakePresets sample for Windows 2024-03-28 20:38:05 +08:00
.gitlab-ci.yml Add macOS CI build 2023-12-17 20:20:14 -05:00
AUTHORS.txt Horizontal/vertical zoom for Simulator plots 2024-03-10 12:43:18 +00:00
CMakeLists.txt Lets try C++20 2024-04-12 23:32:18 -04:00
CMakePresets.json.sample CMakePresets.json.sample: Prefer RelWithDebInfo for x64-Release 2024-03-29 09:59:46 +08:00
CMakeSettings.json.sample Update CMakeSettings.json.sample 2024-02-02 20:19:13 +00:00
CONTRIBUTING.md CONTRIBUTING.md: minor cleanup 2022-10-12 20:56:21 +02:00
INSTALL.txt Bump to requiring wxWidgets 3.2.0 2023-03-05 21:07:57 -05:00
LICENSE Set project license file to GPLv3 for GitLab 2020-07-05 08:56:17 -07:00
LICENSE.3-CLAUSE-BSD ADDED: Read IBIS files 2022-06-09 18:30:51 +00:00
LICENSE.APACHE-2.0 Add support for using a SpaceMouse to pan & zoom in the schematic editor. 2022-03-31 19:03:41 +00:00
LICENSE.BOOSTv1_0 Cleanup licensing 2019-02-11 08:35:23 -08:00
LICENSE.CC-BY-SA-4.0 Adding license text for CC-BY-SA-4.0 for completeness 2019-03-27 14:47:35 -04:00
LICENSE.CC0 Add information about CC0 license 2022-10-18 06:16:50 +02:00
LICENSE.GPLv3 Update license to AGPL due to TTL license. 2018-10-22 12:28:48 -04:00
LICENSE.ISC Cleanup licensing 2019-02-11 08:35:23 -08:00
LICENSE.MIT Adding MIT license 2019-06-09 08:43:43 -07:00
LICENSE.README Update license readme list 2023-10-27 23:58:29 +01:00
README.md Fix bad links on README file 2023-02-23 23:40:28 +00:00
_clang-format Remove clang-format 11+ option 2020-12-15 19:09:46 -05:00
code-of-conduct.md Add Code of Conduct 2020-03-26 11:10:34 -05:00
copyright.h Update copyright template to 2024. 2024-01-01 09:06:31 -05:00
uncrustify.cfg Fix source comment / documentation typos 2021-06-09 19:32:58 +00:00
vcpkg-configuration.json Bump vcpkg for occt 7.8.1 2024-04-02 21:06:47 -04:00
vcpkg.json Add boost bimap to vcpkg 2024-04-02 21:18:58 -04:00

README.md

KiCad README

For specific documentation about building KiCad, policies and guidelines, and source code documentation see the Developer Documentation website.

You may also take a look into the Wiki, the contribution guide.

For general information about KiCad and information about contributing to the documentation and libraries, see our Website and our Forum.

Build state

KiCad uses a host of CI resources.

GitLab CI pipeline status can be viewed for Linux and Windows builds of the latest commits.

Release status

latest released version(s) Release status

Files

  • AUTHORS.txt - The authors, contributors, document writers and translators list
  • CMakeLists.txt - Main CMAKE build tool script
  • copyright.h - A very short copy of the GNU General Public License to be included in new source files
  • Doxyfile - Doxygen config file for KiCad
  • INSTALL.txt - The release (binary) installation instructions
  • uncrustify.cfg - Uncrustify config file for uncrustify sources formatting tool
  • _clang-format - clang config file for clang-format sources formatting tool

Subdirectories

  • 3d-viewer - Sourcecode of the 3D viewer
  • bitmap2component - Sourcecode of the bitmap to PCB artwork converter
  • cmake - Modules for the CMAKE build tool
  • common - Sourcecode of the common library
  • cvpcb - Sourcecode of the CvPCB tool
  • demos - Some demo examples
  • doxygen - Configuration for generating pretty doxygen manual of the codebase
  • eeschema - Sourcecode of the schematic editor
  • gerbview - Sourcecode of the gerber viewer
  • include - Interfaces to the common library
  • kicad - Sourcecode of the project manager
  • libs - Sourcecode of KiCad utilities (geometry and others)
  • pagelayout_editor - Sourcecode of the pagelayout editor
  • patches - Collection of patches for external dependencies
  • pcbnew - Sourcecode of the printed circuit board editor
  • plugins - Sourcecode for the 3D viewer plugins
  • qa - Unit testing framework for KiCad
  • resources - Packaging resources such as bitmaps and operating system specific files
  • scripting - Python integration for KiCad
  • thirdparty - Sourcecode of external libraries used in KiCad but not written by the KiCad team
  • tools - Helpers for developing, testing and building
  • translation - Translation data files (managed through Weblate for most languages)
  • utils - Small utils for KiCad, e.g. IDF, STEP, and OGL tools and converters