Loading Documentation/compiling/COMPILING.txt +2 −2 Original line number Original line Diff line number Diff line Loading @@ -130,10 +130,10 @@ In order to have a working Kicad installtion, you need - documentation and translations (they are not included in sources) - documentation and translations (they are not included in sources) product branch: product branch: bzr branch lp:kicad kicad_src bzr branch https://code.launchpad.net/~kicad-product-committers/kicad kicad_src Stable branch: Stable branch: bzr branch lp:kicad/stable kicad_src bzr branch https://code.launchpad.net/~kicad-product-committers/kicad/stable kicad_src Components and Footprints libraries Components and Footprints libraries all (schematic libs, 3D shapes ...) but new footprints libraries (use Download zip tool) all (schematic libs, 3D shapes ...) but new footprints libraries (use Download zip tool) Loading Documentation/compiling/build-config.txt +3 −41 Original line number Original line Diff line number Diff line Loading @@ -14,7 +14,7 @@ boost libraries will be downloaded the first time you build Kicad. CMake CMake ===== ===== KiCad uses CMake to generate the build files specific for the target platform KiCad uses CMake (version 2.12 or later) to generate the build files specific for the target platform specified by the developer. This document attempts to define some of the more specified by the developer. This document attempts to define some of the more common CMake and KiCad build configuration settings. You can use CMake either common CMake and KiCad build configuration settings. You can use CMake either by the command CMake on or the graphical version ccmake. This document only by the command CMake on or the graphical version ccmake. This document only Loading Loading @@ -78,24 +78,6 @@ the wxWidgets library. If you wish to use a custom built wxWidgets library, set wxWidgets_ROOT_DIR to the correct path. set wxWidgets_ROOT_DIR to the correct path. wxWidgets_USE_DEBUG (ON/OFF) ---------------------------- Default: OFF When creating a debug build of KiCad, it is often useful to link against the debug build of the wxWidgets. To use the debug build of wxWidgets, set wxWidgets_USE_DEBUG to ON. wxWidgets_USE_UNICODE (ON/OFF) ------------------------------ Default: ON (wxWidgets 2.9 or later), OFF (older versions) If your platform supports Unicode and you wish to build KiCad with Unicode support, set wxWidgets_USE_UNICODE to ON. Please note as of the 2.9 branch this option is not required. KiCad Specific Options KiCad Specific Options ====================== ====================== Loading @@ -114,17 +96,6 @@ WARNING: The KiCad developers strongly advise you to build the bundled copy of the Boost library, as it is known to work with KiCad. Other versions may the Boost library, as it is known to work with KiCad. Other versions may contain bugs that may result in KiCad errors. contain bugs that may result in KiCad errors. USE_WX_GRAPHICS_CONTEXT (ON/OFF) -------------------------------- Default: OFF This option is *Experimental*. It enables advanced drawing library code using wxGraphicsContext and should only be used for testing purposes. Under Windows, a very recent version of mingw is needed. It also requires wxWidgets to be built with the --enable-graphics_ctx configuration switch. USE_IMAGES_IN_MENUS (ON/OFF) USE_IMAGES_IN_MENUS (ON/OFF) ---------------------------- ---------------------------- Default: OFF for OSX, ON for other platforms. Default: OFF for OSX, ON for other platforms. Loading @@ -147,20 +118,11 @@ to avoid download and building the dependencies multiple times. KICAD_USER_CONFIG_DIR (PATH) KICAD_USER_CONFIG_DIR (PATH) ---------------------------- ---------------------------- Default: Home directory (Unix-based systems), Application data directory (Windows) Default: ~/.config (Unix-based systems), Application data directory (Windows) This option specifies where to store user-specific configuration information. This option specifies where to store user-specific configuration information. KICAD_KEEPCASE (ON/OFF) ----------------------- Default: ON If this is OFF, component names are automatically converted to uppercase meaning they are case insensitive. If it is ON, component names are not changed and are therefore case sensitive. USE_WX_OVERLAY (ON/OFF) USE_WX_OVERLAY (ON/OFF) ----------------------- ----------------------- Default: ON for OSX, OFF for other platforms. Default: ON for OSX, OFF for other platforms. Loading Loading @@ -192,7 +154,7 @@ KICAD_SCRIPTING_WXPYTHON (ON/OFF) Default: OFF Default: OFF This option enables or disables building wxPython support into the KiCad This option enables or disables building wxPython support into the KiCad scripting support. Currently only Pcbnew is supported. This option requires scripting support. Currently only Pcbnew has scripting support. This option requires SWIG, Python, and wxPython to be installed on the system. SWIG, Python, and wxPython to be installed on the system. Loading Documentation/compiling/build-msw.txt +12 −9 Original line number Original line Diff line number Diff line Loading @@ -103,16 +103,16 @@ install the wxWidgets library into MinGW then enter the following commands: #mkdir Release #mkdir Release #cd Release #cd Release #../configure --with-opengl #../configure --enable-monolithic=no --enable-shared=yes --with-opengl #make #make If you want to install wxWidgets in MinGW then enter the following commands: If you want to install wxWidgets in MinGW then enter the following commands: #mkdir Release #mkdir Release #cd Release #cd Release #../configure --prefix=/mingw --enable-monolithic=no --disable-shared --with-opengl #../configure --prefix=/mingw --enable-monolithic=no --enable-shared=yes --with-opengl #make && make install #make && make install wxWidgets will be statically linked to Kicad, which avoid issus with wxWidgets dlls wxWidgets cannot be statically linked to Kicad. Download the KiCad Source Code Download the KiCad Source Code ------------------------------ ------------------------------ Loading @@ -126,16 +126,19 @@ Launchpad repository has two branches for KiCad sources: near a stable state) near a stable state) To download the testing branch: To download the testing branch: #bzr branch lp:kicad kicad_testing #bzr branch https://code.launchpad.net/~kicad-product-committers/kicad kicad_testing To download the stable branch: To download the stable branch: #bzr branch lp:kicad/stable kicad_stable #bzr branch https://code.launchpad.net/~kicad-product-committers/kicad/stable kicad_stable To download the component and footprint libraries To download the component and footprint libraries: #bzr branch lp:~kicad-lib-committers/kicad/library kicad_libraries (This branch is a bzr/launchpad import of the Git repository at https://github.com/KiCad/kicad-library.git. It has schematic parts and 3D models in it.) #bzr branch https://code.launchpad.net/~kicad-product-committers/kicad/library kicad_libraries To download the documentation and translation files: To download the documentation and translation files: #bzr branch lp:~kicad-developers/kicad/doc kicad_doc #bzr branch https://code.launchpad.net/~kicad-developers/kicad/doc kicad_doc Create Makefiles with CMake Create Makefiles with CMake --------------------------- --------------------------- Loading Loading @@ -219,7 +222,7 @@ Building the Developer Documentation ------------------------------------ ------------------------------------ To build the HTML developer documentation, run the following commands: To build the HTML developer documentation, run the following commands: #cd <kicadSource>/build/debug #cd <kicadSource>/build/release #make doxygen-docs #make doxygen-docs The documentation will be created in the <kicadSouce>/Documentation/html The documentation will be created in the <kicadSouce>/Documentation/html Loading Loading
Documentation/compiling/COMPILING.txt +2 −2 Original line number Original line Diff line number Diff line Loading @@ -130,10 +130,10 @@ In order to have a working Kicad installtion, you need - documentation and translations (they are not included in sources) - documentation and translations (they are not included in sources) product branch: product branch: bzr branch lp:kicad kicad_src bzr branch https://code.launchpad.net/~kicad-product-committers/kicad kicad_src Stable branch: Stable branch: bzr branch lp:kicad/stable kicad_src bzr branch https://code.launchpad.net/~kicad-product-committers/kicad/stable kicad_src Components and Footprints libraries Components and Footprints libraries all (schematic libs, 3D shapes ...) but new footprints libraries (use Download zip tool) all (schematic libs, 3D shapes ...) but new footprints libraries (use Download zip tool) Loading
Documentation/compiling/build-config.txt +3 −41 Original line number Original line Diff line number Diff line Loading @@ -14,7 +14,7 @@ boost libraries will be downloaded the first time you build Kicad. CMake CMake ===== ===== KiCad uses CMake to generate the build files specific for the target platform KiCad uses CMake (version 2.12 or later) to generate the build files specific for the target platform specified by the developer. This document attempts to define some of the more specified by the developer. This document attempts to define some of the more common CMake and KiCad build configuration settings. You can use CMake either common CMake and KiCad build configuration settings. You can use CMake either by the command CMake on or the graphical version ccmake. This document only by the command CMake on or the graphical version ccmake. This document only Loading Loading @@ -78,24 +78,6 @@ the wxWidgets library. If you wish to use a custom built wxWidgets library, set wxWidgets_ROOT_DIR to the correct path. set wxWidgets_ROOT_DIR to the correct path. wxWidgets_USE_DEBUG (ON/OFF) ---------------------------- Default: OFF When creating a debug build of KiCad, it is often useful to link against the debug build of the wxWidgets. To use the debug build of wxWidgets, set wxWidgets_USE_DEBUG to ON. wxWidgets_USE_UNICODE (ON/OFF) ------------------------------ Default: ON (wxWidgets 2.9 or later), OFF (older versions) If your platform supports Unicode and you wish to build KiCad with Unicode support, set wxWidgets_USE_UNICODE to ON. Please note as of the 2.9 branch this option is not required. KiCad Specific Options KiCad Specific Options ====================== ====================== Loading @@ -114,17 +96,6 @@ WARNING: The KiCad developers strongly advise you to build the bundled copy of the Boost library, as it is known to work with KiCad. Other versions may the Boost library, as it is known to work with KiCad. Other versions may contain bugs that may result in KiCad errors. contain bugs that may result in KiCad errors. USE_WX_GRAPHICS_CONTEXT (ON/OFF) -------------------------------- Default: OFF This option is *Experimental*. It enables advanced drawing library code using wxGraphicsContext and should only be used for testing purposes. Under Windows, a very recent version of mingw is needed. It also requires wxWidgets to be built with the --enable-graphics_ctx configuration switch. USE_IMAGES_IN_MENUS (ON/OFF) USE_IMAGES_IN_MENUS (ON/OFF) ---------------------------- ---------------------------- Default: OFF for OSX, ON for other platforms. Default: OFF for OSX, ON for other platforms. Loading @@ -147,20 +118,11 @@ to avoid download and building the dependencies multiple times. KICAD_USER_CONFIG_DIR (PATH) KICAD_USER_CONFIG_DIR (PATH) ---------------------------- ---------------------------- Default: Home directory (Unix-based systems), Application data directory (Windows) Default: ~/.config (Unix-based systems), Application data directory (Windows) This option specifies where to store user-specific configuration information. This option specifies where to store user-specific configuration information. KICAD_KEEPCASE (ON/OFF) ----------------------- Default: ON If this is OFF, component names are automatically converted to uppercase meaning they are case insensitive. If it is ON, component names are not changed and are therefore case sensitive. USE_WX_OVERLAY (ON/OFF) USE_WX_OVERLAY (ON/OFF) ----------------------- ----------------------- Default: ON for OSX, OFF for other platforms. Default: ON for OSX, OFF for other platforms. Loading Loading @@ -192,7 +154,7 @@ KICAD_SCRIPTING_WXPYTHON (ON/OFF) Default: OFF Default: OFF This option enables or disables building wxPython support into the KiCad This option enables or disables building wxPython support into the KiCad scripting support. Currently only Pcbnew is supported. This option requires scripting support. Currently only Pcbnew has scripting support. This option requires SWIG, Python, and wxPython to be installed on the system. SWIG, Python, and wxPython to be installed on the system. Loading
Documentation/compiling/build-msw.txt +12 −9 Original line number Original line Diff line number Diff line Loading @@ -103,16 +103,16 @@ install the wxWidgets library into MinGW then enter the following commands: #mkdir Release #mkdir Release #cd Release #cd Release #../configure --with-opengl #../configure --enable-monolithic=no --enable-shared=yes --with-opengl #make #make If you want to install wxWidgets in MinGW then enter the following commands: If you want to install wxWidgets in MinGW then enter the following commands: #mkdir Release #mkdir Release #cd Release #cd Release #../configure --prefix=/mingw --enable-monolithic=no --disable-shared --with-opengl #../configure --prefix=/mingw --enable-monolithic=no --enable-shared=yes --with-opengl #make && make install #make && make install wxWidgets will be statically linked to Kicad, which avoid issus with wxWidgets dlls wxWidgets cannot be statically linked to Kicad. Download the KiCad Source Code Download the KiCad Source Code ------------------------------ ------------------------------ Loading @@ -126,16 +126,19 @@ Launchpad repository has two branches for KiCad sources: near a stable state) near a stable state) To download the testing branch: To download the testing branch: #bzr branch lp:kicad kicad_testing #bzr branch https://code.launchpad.net/~kicad-product-committers/kicad kicad_testing To download the stable branch: To download the stable branch: #bzr branch lp:kicad/stable kicad_stable #bzr branch https://code.launchpad.net/~kicad-product-committers/kicad/stable kicad_stable To download the component and footprint libraries To download the component and footprint libraries: #bzr branch lp:~kicad-lib-committers/kicad/library kicad_libraries (This branch is a bzr/launchpad import of the Git repository at https://github.com/KiCad/kicad-library.git. It has schematic parts and 3D models in it.) #bzr branch https://code.launchpad.net/~kicad-product-committers/kicad/library kicad_libraries To download the documentation and translation files: To download the documentation and translation files: #bzr branch lp:~kicad-developers/kicad/doc kicad_doc #bzr branch https://code.launchpad.net/~kicad-developers/kicad/doc kicad_doc Create Makefiles with CMake Create Makefiles with CMake --------------------------- --------------------------- Loading Loading @@ -219,7 +222,7 @@ Building the Developer Documentation ------------------------------------ ------------------------------------ To build the HTML developer documentation, run the following commands: To build the HTML developer documentation, run the following commands: #cd <kicadSource>/build/debug #cd <kicadSource>/build/release #make doxygen-docs #make doxygen-docs The documentation will be created in the <kicadSouce>/Documentation/html The documentation will be created in the <kicadSouce>/Documentation/html Loading
