3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
1 |
KiCad installation |
2 |
================== |
|
3 |
||
4 |
The parts of KiCad |
|
5 |
------------------ |
|
6 |
KiCad consists of 3 packages: |
|
7 |
||
8 |
kicad - KiCad programs and core files. |
|
9 |
kicad-doc - Documentation and interactive help (optional package). |
|
10 |
kicad-library - KiCad schematic, pcb & 3D-model libraries (optional package). |
|
11 |
||
12 |
||
13 |
Installation from binary packages |
|
14 |
--------------------------------- |
|
15 |
||
16 |
KiCad binary packages exist for Linux and Windows (XP, 2000). |
|
17 |
||
18 |
Data files (schematic, boards, libraries) are compatible with all platforms. |
|
19 |
||
20 |
*.zip - KiCad packages for Windows. |
|
21 |
*.tbz2 - KiCad for Linux. |
|
22 |
||
23 |
||
24 |
Installation from binary packages for Windows |
|
25 |
--------------------------------------------- |
|
26 |
||
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
27 |
The KiCad binary archive can be installed anywhere on the system that as long as the user |
28 |
has write privileges. |
|
29 |
||
30 |
You can create a shortcut to '${prefix}\bin\kicad.exe' where ${prefix} is the install path. |
|
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
31 |
|
32 |
||
33 |
Installation from binary packages for Linux |
|
34 |
------------------------------------------- |
|
35 |
||
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
36 |
KiCad can be installed in '/usr' or '/usr/local'. You must have "root" access for installation. |
37 |
||
38 |
cd / |
|
39 |
tar -xjf kicad-{version}.tbz2 |
|
40 |
tar -xjf kicad-doc-{version}.tbz2 |
|
41 |
tar -xjf kicad-library-{version}.tbz2 |
|
42 |
||
43 |
The main program is '/usr/bin/kicad'. |
|
44 |
||
45 |
||
46 |
Linux and Windows KiCad install tree |
|
47 |
------------------------------------- |
|
48 |
||
49 |
${prefix}/bin - Binaries (executable files). |
|
50 |
${prefix}/share/doc/kicad/ - Various documentation. |
|
51 |
${prefix}/share/doc/kicad/help - Interactive help. |
|
52 |
${prefix}/share/kicad/demos - Sample schematics and printed boards. |
|
53 |
${prefix}/share/kicad/internat - Dictionaries for interface localization. |
|
54 |
${prefix}/share/kicad/library - Interface localization files. |
|
55 |
${prefix}/share/kicad/modules - Module libraries for printed boards. |
|
56 |
${prefix}/share/kicad/modules/packages3d - 3D component models (.wrl and .wings format). |
|
57 |
||
58 |
KiCad searches for the libraries, templates, 3D models, etc. bin/../share. |
|
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
59 |
|
60 |
Warning: |
|
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
61 |
Do not change the KiCad tree, or the location of binary files. Otherwise |
62 |
KiCad may not be able to find some or all of its required files. |
|
63 |
||
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
64 |
|
65 |
Mac OS X KiCad tree |
|
66 |
------------------- |
|
67 |
||
68 |
System wide files |
|
69 |
||
70 |
/Library/Application Support/kicad/demos |
|
71 |
/Library/Application Support/kicad/internat |
|
72 |
/Library/Application Support/kicad/library |
|
73 |
/Library/Application Support/kicad/modules |
|
74 |
/Library/Application Support/kicad/modules/packages3d |
|
75 |
||
76 |
User files can be the same as the system wide files but only inside the users home directory. |
|
77 |
||
78 |
$HOME/Library/Application Support/kicad |
|
79 |
||
80 |
Warning: |
|
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
81 |
These paths are hardcoded into KiCad, if you put them somewhere else KiCad will not find |
82 |
them when a new project is created. |
|
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
83 |
|
84 |
Installation from source code |
|
85 |
----------------------------- |
|
86 |
||
4379
by jean-pierre charras
Remove wxUSE_UNICODE definition from CMakeLists.txt, because this define comes from wxWidgets and should not be made inside kicad |
87 |
Some dependencies must be satisfied for the correct installation of KiCad: |
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
88 |
|
89 |
wxWidgets >= 3.0.0 http://www.wxwidgets.org/ |
|
90 |
||
91 |
CMake >= 2.8.4 http://www.cmake.org/ |
|
92 |
||
4379
by jean-pierre charras
Remove wxUSE_UNICODE definition from CMakeLists.txt, because this define comes from wxWidgets and should not be made inside kicad |
93 |
Boost C++ Libraries: |
94 |
files used by kicad are autmatically downloaded and patched if needed |
|
95 |
from boost site ( http://www.boost.org/ ) |
|
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
96 |
|
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
97 |
OpenGL |
98 |
Linux: Mesa 3D Graphics Library http://www.mesa3d.org/ |
|
99 |
Windows: built-in |
|
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
100 |
|
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
101 |
Zlib Compression Library http://www.zlib.net/ |
102 |
||
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
103 |
In source-tree-build are mostly unwanted, so make a subdir called "build" and |
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
104 |
change to it. |
105 |
||
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
106 |
Call cmake with the path to KiCad. E.g., when your build-folder is "build" |
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
107 |
within source-tree, type "cmake ../". |
108 |
||
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
109 |
Now your system get checked if it is able compiling KiCad and cmake generates |
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
110 |
the Makefiles. |
111 |
||
112 |
After calling cmake just type "make" and build begins. |
|
113 |
||
114 |
It is easy to build only a specific binary such as pcbnew alone: |
|
115 |
make pcbnew |
|
116 |
||
117 |
After "make" type "make install" and install begins. |
|
118 |
||
119 |
You may install to a temporary-root with |
|
120 |
make install DESTDIR=<temproot> |
|
121 |
||
122 |
If you want to uninstall KiCad again type "make uninstall" from within the |
|
123 |
build directory. |
|
124 |
||
125 |
||
126 |
Important parameters to cmake |
|
127 |
----------------------------- |
|
128 |
||
4714
by Blair Bonnett
Build documentation updates and comment spelling fixes. |
129 |
See Documentation/compiling/build-config.txt for a list of all CMake options |
130 |
available when compiling KiCad. |
|
131 |
||
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
132 |
-DCMAKE_BUILD_TYPE=<buildtype> |
133 |
<buildtype> may current one of "Debug" and "Release". |
|
134 |
||
135 |
-DCMAKE_INSTALL_PREFIX=<prefix> |
|
136 |
Default to "/usr/local". |
|
137 |
||
138 |
-DwxWidgets_ROOT_DIR=<wxInstallDir> |
|
139 |
Required for Windows platform. |
|
140 |
||
141 |
-DwxWidgets_USE_DEBUG=ON |
|
142 |
Can be used only with -DCMAKE_BUILD_TYPE=Debug |
|
143 |
||
144 |
-DKICAD_KEEPCASE=ON |
|
145 |
Build the KiCad with no component name conversion to uppercase (if you want your |
|
146 |
ADuC.../Si.../bq... components named as just so). |
|
147 |
||
148 |
-DCMAKE_CXX_FLAGS=<some extra flags> |
|
149 |
Extra flags for the c++ compiler for your system required. |
|
150 |
||
151 |
-DCMAKE_VERBOSE_MAKEFILE=ON |
|
152 |
When more output is wanted use this cmake parameter or call "make VERBOSE=1". |
|
153 |
||
154 |
||
155 |
Extra CFLAGS and linker flags |
|
156 |
----------------------------- |
|
157 |
||
4798.1.447
by Wayne Stambaugh
Change Windows install tree to match Linux install tree. |
158 |
If you require extra flags for compiler and linker you may give them via |
3384
by jean-pierre charras
Restore INSTALL.txt, erroneously removed. |
159 |
environment variables |
160 |
"CXXFLAGS" (c++ compiler) |
|
161 |
"LDFLAGS" (for linker) |
|
162 |
"CFLAGS" (for c-compiler, not needed in kdesvn build) |
|
163 |
||
164 |
eg., it may usefull on 64bit systems "-m64" to CXXFLAGS and LDFLAGS. |