KiCad README

For specific documentation like Compiling, GUI translation, old changelogs see the Documentation subfolder.

You may also take a look into the Wiki, the Developers section on 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. Old changelogs etcetera.
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)
new - Staging area for the new schematic library format
pagelayout_editor - Sourcecode of the pagelayout editor
patches - Collection of patches for external dependencies
pcbnew - Sourcecode of the printed circuit board editor
plugins - Sourcecode of the new plugin concept
polygon - Sourcecode of the polygon library
qa - Testcases using the python interface
resources - Resources for freedesktop mime-types for linux
scripting - SWIG Python scripting definitions and build scripts
scripts - Example scripts for distribution with KiCad
template - Project and pagelayout templates
thirdparty - Sourcecode of external libraries used in kicad but not written by Kicad team
tools - Other miscellaneous helpers for testing
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 18,602 Commits
.githooks		.githooks
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
new		new
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
utils		utils
.clang-tidy		.clang-tidy
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitlab-ci.yml		.gitlab-ci.yml
AUTHORS.txt		AUTHORS.txt
CMakeLists.txt		CMakeLists.txt
CTestConfig.cmake		CTestConfig.cmake
Doxyfile		Doxyfile
INSTALL.txt		INSTALL.txt
LICENSE.AGPLv3		LICENSE.AGPLv3
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