kicad / kicad.github.io

KiCad Library Download Page

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

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
  • 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

kicad.github.io's Issues

Would it be a good idea to offer regular snapshots of the libs?

Just a stupid idea i had to allow people to easily download past states of the lib (without the need to know about git.)
Use cases would include rescuing a project where somebody accidentally deleted the cache lib. (See current problems on the mailing list)

This might also be a good idea for people who work together on a project. They could say they all use the lib snapshot from Nov. 2017

In my mind this could be as simple as tagging the libs on a regular basis.

broken links at footprint page

Many links, if not all at https://kicad.github.io/footprints/Resistor_SMD are broken. Sometimes, there is a rendering error, which adds a closing bracket to the links like for Vishay. The other links to kicad.github.io link to missing pdfs like, mnr_g.pdf.

This issue applies to further libraries as well, like to Inductor_SMD.

Cannot Print to Windows PDF in PCBNew

Every time I try to print a PDF for fabrication, KiCad locks up. It does the same with XPS. PDF printer works fine in other programs, just not KiCad.

Split processing into multiple travis vm's

The last build errored because of an timeout (I restarted it to check if it completes now)

A simple idea to improve the build reliability would be to split symbol, footprint and 3d model parsing, and do it sequence. We could abuse https://docs.travis-ci.com/user/build-stages/ to do this.

A possible disatvantage of this would be that it's theroretically possible to have for example a kicad.github.io with up-to-date symbols, but old 3d-models

Legacy 3D model folders are not being deleted

The build script is not correctly purging 3D model directories that no longer exist in the repo.

update issue with https://kicad.github.io/packages3d

The pages under https://kicad.github.io/packages3d are not being updated properly.

For example, https://kicad.github.io/packages3d/Converter_ACDC shows the text "Last updated on 20 October 2018" but the models listed there are not in sync with the gitgub 3d model repo as of Oct 20th.
eg. Converter_ACDC_RECOM_RAC04-xxSGx_THT.step has existed for almost a month in https://github.com/KiCad/kicad-packages3D but it's not shown in the table on https://kicad.github.io/packages3d/Converter_ACDC

comparing md5sums of compressed files

I saw the script checks if the md5sum of compressed files changes between builds. I expect this to be extremly unreliable. What about storing the commit id of the last checkout, and using git to determine if a directory was changed since last processing?

travis build is too frequent

Seems like the travis build robot's cron is telling this repo to be built every day (is that correct?) Maybe we should go back to a weekly build cadence so that this repo's size doesn't explode.