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

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
CTestConfig.cmake - Support for CTest and CDash testing tools
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
bitmaps_png - Menu and program icons
CMakeModules - Modules for the CMAKE build tool
common - Sourcecode of the common library
cvpcb - Sourcecode of the CvPCB tool
demos - Some demo examples
Documentation - Developer documentation (deprecated; moved to https://dev-docs.kicad.org)
eeschema - Sourcecode of the schematic editor
gerbview - Sourcecode of the gerber viewer
helpers - Helper tools and utilities for development
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 for various operating systems
scripting - SWIG Python scripting definitions and build scripts
scripts - Example scripts for distribution with KiCad
template - Project template
thirdparty - Sourcecode of external libraries used in kicad but not written by Kicad team
tools - Other miscellaneous helpers for testing
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 26,629 Commits
.githooks		.githooks
.github		.github
.gitlab		.gitlab
3d-viewer		3d-viewer
CMakeModules		CMakeModules
Documentation		Documentation
bitmap2component		bitmap2component
bitmaps_png		bitmaps_png
common		common
cvpcb		cvpcb
demos		demos
eeschema		eeschema
gerbview		gerbview
helpers		helpers
include		include
kicad		kicad
libs		libs
pagelayout_editor		pagelayout_editor
patches		patches
pcb_calculator		pcb_calculator
pcbnew		pcbnew
plugins		plugins
qa		qa
resources		resources
scripting		scripting
scripts		scripts
template		template
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
Doxyfile		Doxyfile
DoxygenLayout.xml		DoxygenLayout.xml
INSTALL.txt		INSTALL.txt
LICENSE		LICENSE
LICENSE.BOOSTv1_0		LICENSE.BOOSTv1_0
LICENSE.CC-BY-SA-4.0		LICENSE.CC-BY-SA-4.0
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