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.

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

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
- bitmaps_png - Menu and program icons
- project_template - Project template
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

Name		Name	Last commit message	Last commit date
Latest commit History 37,806 Commits
.githooks		.githooks
.github		.github
.gitlab		.gitlab
3d-viewer		3d-viewer
bitmap2component		bitmap2component
cmake		cmake
common		common
cvpcb		cvpcb
demos		demos
doxygen		doxygen
eeschema		eeschema
gerbview		gerbview
include		include
kicad		kicad
libs		libs
pagelayout_editor		pagelayout_editor
pcb_calculator		pcb_calculator
pcbnew		pcbnew
plugins		plugins
qa		qa
resources		resources
scripting		scripting
signing		signing
thirdparty		thirdparty
tools		tools
translation		translation
utils		utils
.clang-tidy		.clang-tidy
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitlab-ci.yml		.gitlab-ci.yml
AUTHORS.txt		AUTHORS.txt
CMakeLists.txt		CMakeLists.txt
CMakeSettings.json.sample		CMakeSettings.json.sample
CONTRIBUTING.md		CONTRIBUTING.md
INSTALL.txt		INSTALL.txt
LICENSE		LICENSE
LICENSE.3-CLAUSE-BSD		LICENSE.3-CLAUSE-BSD
LICENSE.APACHE-2.0		LICENSE.APACHE-2.0
LICENSE.BOOSTv1_0		LICENSE.BOOSTv1_0
LICENSE.CC-BY-SA-4.0		LICENSE.CC-BY-SA-4.0
LICENSE.CC0		LICENSE.CC0
LICENSE.GPLv3		LICENSE.GPLv3
LICENSE.ISC		LICENSE.ISC
LICENSE.MIT		LICENSE.MIT
LICENSE.README		LICENSE.README
README.md		README.md
_clang-format		_clang-format
code-of-conduct.md		code-of-conduct.md
copyright.h		copyright.h
uncrustify.cfg		uncrustify.cfg
vcpkg-configuration.json		vcpkg-configuration.json
vcpkg.json		vcpkg.json