kicad-developers team mailing list archive
-
kicad-developers team
-
Mailing list archive
-
Message #26021
[PATCH] A few small changes to CMake and the compiling instructions
0001 changes the USE_OCE flag to KICAD_USE_OCE as discussed.
0002 adds libngspice and OCE to the INSTALL.txt dependencies list and
removes a dead link
0003 updates compiling.md to remove bzr references and adds info about the
KICAD_USE_OCE flag
Jon
From ba66aab6cdfcb3ad9ea0c2c130470b92c2611c0b Mon Sep 17 00:00:00 2001
From: Jon Neal <reportingsjr@xxxxxxxxx>
Date: Sat, 3 Sep 2016 16:24:00 -0400
Subject: [PATCH 3/3] Updated the compiling instructions to remove bzr and talk
about the OCE flag.
---
Documentation/development/compiling.md | 36 ++++++++++++++--------------------
1 file changed, 15 insertions(+), 21 deletions(-)
diff --git a/Documentation/development/compiling.md b/Documentation/development/compiling.md
index 9fc3d53..42cfb53 100644
--- a/Documentation/development/compiling.md
+++ b/Documentation/development/compiling.md
@@ -23,18 +23,12 @@ Some of these tools are required to build from source and some are optional.
[CMake][] is the build configuration and makefile generation tool used by KiCad. It is required.
-## Bazaar Version Control System ## {#bazaar}
-
-The official source code repository is hosted on [Launchpad][] and requires the [Bazaar][] version
-control system in order to create a branch of the latest source. Bazaar is not required if you are
-going to build a stable version of KiCad from a source archive.
-
## GIT Version Control System ## {#git}
-If you prefer to use [GIT][] for version control, there is a mirror of the official KiCad
-repository on [GitHub][]. GIT is not required if you are going to build a stable version of
-KiCad from a source archive. Please note that the GitHub mirror is read only. Do not submit
-pull requests to GitHub. Changes should be sent to the KiCad developer's [mailing list][] as
+The official source code repository is hosted on [Launchpad][] and
+requires git to get the latest source. If you prefer to use [GitHub][] there is a
+read only mirror of the official KiCad repository. Do not submit pull requests to GitHub.
+Changes should be sent to the KiCad developer's [mailing list][] as
an attached patch with [PATCH] at the beginning of the subject.
## Doxygen Code Documentation Generator ## {#doxygen_section}
@@ -157,7 +151,13 @@ enabled by default.
## Integrated Spice simulator ## {#spice_opt}
The KICAD_SPICE option is used to control if the Spice simulator interface for eeschema is built. When
-the options is enabled, it requires [ngspice][] to be available as a shared library. This option is
+this option is enabled, it requires [ngspice][] to be available as a shared library. This option is
+disabled by default.
+
+## STEP and IGES model support ## {#oce_opt}
+
+The KICAD_USE_OCE option is used to enable STEP and IGES model support for the 3d viewer. When enabled
+this requires the location of the installed OCE libary to be passed via the OCE_DIR flag. This option is
disabled by default.
# Getting the KiCad Source Code ## {#getting_src}
@@ -170,20 +170,15 @@ following command:
tar -xzf kicad_src_archive.tar.gz
If you are contributing directly to the KiCad project on Launchpad, you can create a local
-branch on your machine by using the following command:
-
- bzr branch https://code.launchpad.net/~kicad-product-committers/kicad/product kicad_source
-
-If you prefer to use [GIT][] as you version control system, you can clone the KiCad mirror on
-GitHub using the following command:
+copy on your machine by using the following command:
- git clone https://github.com/KiCad/kicad-source-mirror
+ git clone -b master https://git.launchpad.net/kicad
Here is a list of source links:
Stable release archive: https://launchpad.net/kicad/4.0/4.0.2/+download/kicad-4.0.2.tar.xz
-Development branch: https://code.launchpad.net/~kicad-product-committers/kicad/product
+Development branch: https://code.launchpad.net/~kicad-product-committers/kicad/+git/product-git/+ref/master
GitHub mirror: https://github.com/KiCad/kicad-source-mirror
@@ -379,8 +374,7 @@ you will have to apply the Boost patches in the KiCad source [patches folder][].
[GNU GCC]: https://gcc.gnu.org/
[Clang]: http://clang.llvm.org/
[CMake]: https://cmake.org/
-[Launchpad]: https://code.launchpad.net/~kicad-product-committers/kicad/product
-[Bazaar]: http://bazaar.canonical.com/en/
+[Launchpad]: https://code.launchpad.net/kicad/
[GIT]: https://git-scm.com/
[GitHub]: https://github.com/KiCad/kicad-source-mirror
[ngspice]: http://ngspice.sourceforge.net/
--
2.5.5
From e8298d30e9cb604dc2db9011b3252ae4b1d43d77 Mon Sep 17 00:00:00 2001
From: Jon Neal <reportingsjr@xxxxxxxxx>
Date: Sat, 3 Sep 2016 16:04:08 -0400
Subject: [PATCH 2/3] Updated INSTALL.txt to list new dependncies. Fixed a dead
link to documentation as well.
---
INSTALL.txt | 36 ++++++++++++++++++++----------------
1 file changed, 20 insertions(+), 16 deletions(-)
diff --git a/INSTALL.txt b/INSTALL.txt
index b1403c5..0c14d32 100644
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -88,39 +88,43 @@ Currently the only supported compilers are GCC on linux and windows and clang on
Some dependencies must be satisfied for the correct installation of KiCad:
-wxWidgets >= 3.0.0 http://www.wxwidgets.org/
+wxWidgets >= 3.0.0 http://www.wxwidgets.org/
-CMake >= 2.8.4 http://www.cmake.org/
+CMake >= 2.8.4 http://www.cmake.org/
-Boost C++ Libraries: >= 1.54 http://www.boost.org/
+Boost C++ Libraries: >= 1.54 http://www.boost.org/
files used by kicad are autmatically downloaded and patched if needed
from boost site.
OpenGL >= 2.1
- Linux: Mesa 3D Graphics Library http://www.mesa3d.org/
+ Linux: Mesa 3D Graphics Library http://www.mesa3d.org/
Windows: built-in
-Zlib Compression Library http://www.zlib.net/
+Zlib Compression Library http://www.zlib.net/
-cairo http://cairographics.org/
+cairo http://cairographics.org/
-GLEW http://glew.sourceforge.net/
+GLEW http://glew.sourceforge.net/
-libcurl http://curl.haxx.se/
+libcurl http://curl.haxx.se/
-OpenMP (optional) http://openmp.org/
+OpenMP (optional) http://openmp.org/
-GLM >= 9.5.4 http://glm.g-truc.net/
+GLM >= 9.5.4 http://glm.g-truc.net/
-pkg-config http://pkgconfig.freedesktop.org/
+pkg-config http://pkgconfig.freedesktop.org/
-Doxygen (optional) http://www.stack.nl/~dimitri/doxygen/index.html
+Doxygen (optional) http://www.stack.nl/~dimitri/doxygen/index.html
-python >= 2.6 (optional) http://python.org/
+python >= 2.6 (optional) http://python.org/
-wxPython (optional) http://www.wxpython.org/
+wxPython (optional) http://www.wxpython.org/
-SWIG >= 3.0 (optional) http://swig.org/
+SWIG >= 3.0 (optional) http://swig.org/
+
+libngspice (optional) http://ngspice.sourceforge.net/
+
+OCE >= 0.16 (optional) https://github.com/tpaviot/oce
In source-tree-build are mostly unwanted, so make a subdir called "build" and
change to it.
@@ -148,7 +152,7 @@ build directory.
Important parameters to cmake
-----------------------------
-See Documentation/compiling/build-config.txt for a list of all CMake options
+See Documentation/development/compiling.md for a list of all CMake options
available when compiling KiCad.
-DCMAKE_BUILD_TYPE=<buildtype>
--
2.5.5
From 9a57334825959c61dd590c14ad600329fea08d69 Mon Sep 17 00:00:00 2001
From: Jon Neal <reportingsjr@xxxxxxxxx>
Date: Sat, 3 Sep 2016 15:51:01 -0400
Subject: [PATCH 1/3] Update OCE cmake flag from USE_OCE to KICAD_USE_OCE.
---
CMakeLists.txt | 4 ++--
plugins/3d/CMakeLists.txt | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 3b3ba64..f4fd6b3 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -45,7 +45,7 @@ option( USE_SCH_IO_MANAGER
"Build Eeschema with the I/O manager for handling schematic and symbol library I/O. (default OFF)"
)
-option( USE_OCE
+option( KICAD_USE_OCE
"Build tools and plugins related to OpenCascade Community Edition (default OFF)"
)
@@ -512,7 +512,7 @@ if( KICAD_SPICE )
endif()
# Find OpenCascade Community Edition, required for STEP plugin and tools
-if( USE_OCE )
+if( KICAD_USE_OCE )
set( LIBS_OCE TKBinXCAF TKPCAF TKSTEP TKXDESTEP TKIGES TKXDEIGES )
find_package( OCE 0.16 REQUIRED ${LIBS_OCE} )
diff --git a/plugins/3d/CMakeLists.txt b/plugins/3d/CMakeLists.txt
index 5cd00fe..8738996 100644
--- a/plugins/3d/CMakeLists.txt
+++ b/plugins/3d/CMakeLists.txt
@@ -1,6 +1,6 @@
add_subdirectory( idf )
add_subdirectory( vrml )
-if( USE_OCE )
+if( KICAD_USE_OCE )
add_subdirectory( oce )
-endif( USE_OCE )
+endif( KICAD_USE_OCE )
--
2.5.5
Follow ups