• This repository has been archived on 25/Apr/2024
  • Stars
    star
    124
  • Rank 288,207 (Top 6 %)
  • Language CMake
  • License
    Other
  • Created about 10 years ago
  • Updated about 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

KiCad new documentation repository [moved to https://gitlab.com/kicad/services/kicad-doc]

KiCad Documentation

This repository contains the official KiCad documentation.

Build Status Stable version docs Nightly docs

Contributing

You can discuss the documentation and its translations in the repository issues.

To participate to the translation effort read the translation_instructions.adoc.
Submit your translation pull requests to the master branch, please.
See docs-versioning.adoc for details about docs versioning.

The following instructions explain how to test changes before submitting a pull-request.

Dependencies

  • AsciiDoc >= 8.6.9 is both the language of the documentation and the tool used to generate the PDF and HTML outputs.

We will probably switch to asciidoctor in the future, when asciidoctor tools are stable enough, because of their ability to generate PDF and epub document formats directly without the intervention of any other external tool or intermediate format like dblatex or docbook. See the asciidoctor-pdf project.

  • po4a >= 0.45 is used to translate the English AsciiDoc documentation to other languages before the last compilation steps.

  • CMake >= 2.8

  • dblatex >= 0.3.4

  • gettext >= 0.18

  • source-highlight

  • The VL Gothic font is required when you build the Japanese PDFs. Look for a package named fonts-vlgothic. Otherwise use the LANGUAGES option to avoid build errors.

  • For building PDF files with Cyrillic characters (like Russian) the fonts package freefont-ttf is required, so you will need to look for similar named package.

Debian / Ubuntu

To install the dependencies on Debian / Ubuntu run the following (requires about 1.5GiB of space):

sudo apt-get install asciidoc cmake dblatex fonts-freefont-ttf \
fonts-vlgothic gettext git make po4a source-highlight \
texlive-lang-cyrillic texlive-lang-english texlive-lang-european \
texlive-lang-french texlive-lang-german texlive-lang-italian \
texlive-lang-japanese texlive-lang-other texlive-lang-polish \
texlive-lang-spanish texlive-xetex texlive-lang-chinese \
libunicode-linebreak-perl
Note
Debian Jessie and Ubuntu 16.04 LTS has no package texlive-lang-european, install the package texlive-lang-dutch instead.
Note
in Ubuntu 14.04 LTS there is no texlive-lang-japanese. Install texlive-lang-cjk instead.

or, if you do not have space problems:

sudo apt-get install asciidoc cmake dblatex fonts-freefont-ttf \
fonts-vlgothic gettext git make po4a source-highlight \
texlive-lang-all texlive-xetex libunicode-linebreak-perl

Fedora

To install the dependencies on Fedora run the following:

sudo dnf install git make cmake asciidoc gettext po4a dblatex \
source-highlight texlive vlgothic-fonts perl-Unicode-LineBreak \
texlive-scheme-full texlive-collection-xetex gnu-free-serif-fonts \
gnu-free-mono-fonts gnu-free-sans-fonts

Manjaro Linux

To install the dependencies on Manjaro run the following:

sudo  pacman -S asciidoc cmake dblatex ttf-freefont gettext \
po4a source-highlight  texlive-langchinese texlive-langcyrillic \
texlive-langjapanese texlive-langextra texlive-langkorean \
texlive-langgreek perl-unicode-linebreak
Note
AUR package
yaourt -S ttf-vlgothic

Building the docs

Windows

Start with windows_dependencies.adoc then run:

cd kicad-doc
mkdir build
cd build
cmake -G "MinGW Makefiles" -DPDF_GENERATOR=FOP ../
make

MacOS / Linux

cd kicad-doc
mkdir build
cd build
cmake ../
make

Docker

Read utils/docker/README.adoc if you want to build the documentation in a container.

CMake Build Options

BUILD_FORMATS

By default BUILD_FORMATS is set to "html;pdf;epub" to enable building all supported document formats.

It’s possible to set BUILD_FORMATS in order to build only a subset of formats, e.g. -DBUILD_FORMATS=html

When only one build format is enabled the package name is transformed to include the format.

LANGUAGES

By default CMake will configure to build all languages available for each document.

You can build just one or some of the languages by using the LANGUAGES option when configuring a build with CMake, e.g. -DLANGUAGES="it;en;de", etc.

Currently, the available languages are : ca, de, en, es, fr, id, it, ja, pl, ru and zh, however, any language code can be selected. Only translated documents will be built, so for some languages there may only be a partial documentation output.

SINGLE_LANGUAGE

This option is deprecated, use LANGUAGES instead

PDF_GENERATOR

By default CMake will use dblatex building PDFs.

You can build PDFs however using either DBLATEX or FOP by using the PDF_GENERATOR option whilst configuring a CMake build.

For example, use -DPDF_GENERATOR=FOP to use FOP to build the PDFs. If the BUILD_FORMATS option doesn’t include pdf, the PDF_GENERATOR option will have no effect on the build.

This option doesn’t transform the built package name.

Packaging the docs

The docs use CMake as mentioned earlier, so to install it as a packager use the normal CMake way, for example:

mkdir build; cd build
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make install

And if on OS X you might want something like:

mkdir build; cd build
cmake -DCMAKE_INSTALL_PREFIX="/Library/Application Support/kicad" ..
make install

More Repositories

1

kicad-source-mirror

This is an active mirror of the KiCad development branch, which is hosted at GitLab (updated every time something is pushed). Pull requests on GitHub are not accepted or watched.
C++
1,830
star
2

kicad-library

The schematic and 3D libraries for KiCad 4.0. Note that the footprint libraries are the *.pretty repos themselves. This is an orphaned repo, the news about the v5 libs, http://kicad.org/post/kicad-official-libraries/.
HTML
749
star
3

kicad-symbols

Official KiCad schematic symbol libraries for Kicad 5
CMake
704
star
4

kicad-footprints

Official KiCad Footprint Libraries for Kicad version 5
CMake
620
star
5

kicad-packages3D

Official KiCad 3D model libraries for rendering and MCAD integration
CMake
474
star
6

kicad-templates

KiCad project templates
HTML
169
star
7

kicad-library-utils

Some scripts for helping with library development
Python
128
star
8

KicadOSXBuilder

Kicad OSX Builder, which I plan to use as my boxed development environment on Mac OSX
Shell
87
star
9

kicad-website

This is the official website source for KiCad [moved to https://gitlab.com/kicad]
HTML
62
star
10

kicad-i18n

Translations for KiCad source code [moved to https://gitlab.com/kicad]
Shell
58
star
11

kicad-winbuilder

Windows builder for the KiCad project based on the MSYS2 MinGW system [moved to https://gitlab.com/kicad]
NSIS
51
star
12

kicad-packages3D-source

Source files for generating 3D models
Python
50
star
13

kicad.github.io

KiCad Library Download Page
HTML
36
star
14

Connectors_JST.pretty

JST connector footprints
22
star
15

kicad-footprint-wizards

Python
18
star
16

Buttons_Switches_THT.pretty

Buttons and switches, through hole footprints
14
star
17

kicad-mac-builder

The macOS V5+ KiCad builder and packager [moved to https://gitlab.com/kicad]
CMake
13
star
18

Buttons_Switches_Keyboard.pretty

Buttons and switches for keyboard applications
13
star
19

Connectors.pretty

Assorted connector footprints
12
star
20

Connectors_Molex.pretty

Molex connector footprints
10
star
21

Pin_Headers.pretty

9
star
22

LEDs.pretty

7
star
23

Modules.pretty

Footprints for SoM (System on Module), typically functional modules integrated onto a separate PCB
6
star
24

Housings_DFN_QFN.pretty

Dual and Quad Flat No-lead footprints
6
star
25

SMD_Packages.pretty

6
star
26

Battery_Holders.pretty

Battery holder footprints
6
star
27

Housings_SSOP.pretty

Shrink Small Outline Package footprints
5
star
28

Housings_DIP.pretty

Dual Inline Package footprints
5
star
29

Mounting_Holes.pretty

5
star
30

Housings_QFP.pretty

Quad Flat Package footprints
5
star
31

TO_SOT_Packages_SMD.pretty

4
star
32

RF_Modules.pretty

4
star
33

Crystals.pretty

Crystal footprints
4
star
34

Capacitors_Tantalum_SMD.pretty

4
star
35

Resistors_SMD.pretty

3
star
36

Converters_DCDC_ACDC.pretty

3
star
37

Connectors_TE-Connectivity.pretty

TE-Connectivity connector footprints
3
star
38

Connectors_Hirose.pretty

Hirose connector footprints
3
star
39

Socket_Strips.pretty

3
star
40

Sockets.pretty

3
star
41

Fiducials.pretty

3
star
42

Heatsinks.pretty

3
star
43

Capacitors_SMD.pretty

Surface mount capacitor footprints
3
star
44

Diodes_SMD.pretty

Surface mount diode footprints
3
star
45

Connectors_USB.pretty

USB (Universal Serial Bus) connector footprints
3
star
46

Connectors_Card.pretty

Footprints for cards and card holders
2
star
47

Connectors_Harwin.pretty

Harwin connector footprints
2
star
48

Buttons_Switches_SMD.pretty

Buttons and switches, surface mount footprints
2
star
49

Connectors_Samtec.pretty

Samtec connector footprints
2
star
50

Fuse_Holders_and_Fuses.pretty

2
star
51

TerminalBlock.pretty

2
star
52

Displays_7-Segment.pretty

2
star
53

Connectors_Amphenol.pretty

Amphenol connector footprints
2
star
54

Resistors_THT.pretty

2
star
55

Connectors_JAE.pretty

JAE connector footprints
2
star
56

Symbols.pretty

2
star
57

Connectors_Multicomp.pretty

Multicomp connector footprints
2
star
58

Displays.pretty

Shell
2
star
59

TO_SOT_Packages_THT.pretty

2
star
60

Connectors_IDC.pretty

IDC connector footprints
2
star
61

Antennas.pretty

Footprints for Radio Frequency Antennas
2
star
62

fedora-packaging

Fedora packaging for KiCad used for the nightlies and distributed via copr [moved to https://gitlab.com/kicad]
Shell
2
star
63

Potentiometers.pretty

2
star
64

Capacitors_THT.pretty

Through hole capacitor footprints
2
star
65

kicad-doc-website

[moved to https://gitlab.com/kicad]
CSS
2
star
66

Wire_Connections_Bridges.pretty

2
star
67

Inductors_SMD.pretty

Surface mount inductor footprints
2
star
68

Inductors_THT.pretty

Through hole inductor footprints
2
star
69

Diodes_THT.pretty

2
star
70

Housings_SON.pretty

SON (Small Outline No-Lead) package footprints
2
star
71

Connectors_DSub.pretty

DB connector footprints
2
star
72

Resistors_Universal.pretty

2
star
73

Connectors_IEC_DIN.pretty

2
star
74

Buzzers_Beepers.pretty

2
star
75

Oscillators.pretty

2
star
76

Connectors_Phoenix.pretty

Phoenix connector footprints
2
star
77

Transformers_SMD.pretty

Surface mount transformer footprints
1
star
78

PFF_PSF_PSS_Leadforms.pretty

1
star
79

Transformers_THT.pretty

Through hole transformer footprints
1
star
80

Housings_LGA.pretty

Land Grid Array footprints
1
star
81

Measurement_Scales.pretty

1
star
82

Oddities.pretty

1
star
83

Valves.pretty

1
star
84

Transformers_CHK.pretty

1
star
85

Inductors.pretty

Inductor footprints - deprecated
1
star
86

Connectors_Mini-Universal.pretty

1
star
87

Power_Integrations.pretty

1
star
88

Choke_Toroid_ThroughHole.pretty

Deprecated (see Inductors_SMD and Inductors_THT)
1
star
89

divers.pretty

Deprecated - DO NOT USE
1
star
90

Housings_SIP.pretty

Single Inline Package (SIP) footprints
1
star
91

Choke_Common-Mode_Wurth.pretty

Deprecated (see Inductors_SMD and Inductors_THT)
1
star
92

Choke_SMD.pretty

Deprecated
1
star
93

Housings_SOIC.pretty

Small Outline Integrated Circuit footprints
Shell
1
star
94

Filters_HF_Coils_NEOSID.pretty

1
star
95

Inductors_NEOSID.pretty

1
star
96

Varistors.pretty

1
star
97

Choke_Radial_ThroughHole.pretty

Deprecated (see Inductors_SMD and Inductors_THT)
1
star
98

Shielding_Cabinets.pretty

1
star
99

Opto-Devices.pretty

1
star
100

Housings_LCC.pretty

Leaded Chip Carrier footprints
1
star