11IfcOpenShell
22============
3- open source (LGPL) software library for working with the IFC file format
3+ Open source (LGPL) software library for working with the IFC file format.
44
55[ http://ifcopenshell.org ] ( http://ifcopenshell.org )
66[ http://academy.ifcopenshell.org ] ( http://academy.ifcopenshell.org )
77
88
9+ Prerequisites
10+ =============
11+ * Git, CMake (2.6 or newer), Visual Studio 2008 or newer (Windows), or GCC (* nix, Clang untested).
12+
13+
914Dependencies
1015============
1116* [ Boost] ( http://www.boost.org/ )
12- * Open Cascade * optional* , but required for building IfcGeom)
17+ * Open Cascade * optional* , but required for building IfcGeom
1318 [ Official] ( http://www.opencascade.org/getocc/download/loadocc/ ) or [ community edition] ( https://github.com/tpaviot/oce )
1419 For converting IFC representation items into BRep solids and tesselated meshes
1520* [ ICU] ( http://site.icu-project.org/ ) * optional*
@@ -18,32 +23,44 @@ Dependencies
1823 For IfcConvert to be able to write tessellated Collada (.dae) files
1924* [ SWIG] ( http://www.swig.org/ ) , [ Python] ( https://www.python.org/ ) libraries * optional*
2025 For building the IfcOpenShell Python interface and the Blender add-on
21- * 3ds max SDK * optional*
22- For building the 3ds max plug-in
26+ * 3ds Max SDK * optional*
27+ For building the 3ds Max plug-in
2328
2429
2530Compiling on Windows
2631====================
27- Users are advised to use the Visual Studio .sln file in the win/ folder.
28- For Windows users a prebuilt Open CASCADE version is available from the
29- http://opencascade.org website. Download and install this version and
30- provide the paths to the Open CASCADE header and library files to MS
31- Visual Studio C++.
32+ Users are advised to build IfcOpenShell using the CMake file provided in
33+ the cmake/ folder.
34+
35+ The preferred way to fetch and build this project's dependencies is to use the build scripts
36+ in win/ folder. ** See [ win/readme.md] for more information** . Instructions in a nutshell
37+ (** assuming Visual Studio 2015 x64 environment variables set** ):
38+
39+ > git clone https://github.com/IfcOpenShell/IfcOpenShell.git
40+ > cd IfcOpenShell\win
41+ > build-deps.cmd
42+ > run-cmake.bat
43+
44+ You can now open and build the solution file in Visual Studio:
3245
33- For building the Autodesk 3ds Max plugin, the 3ds Max SDK needs to be
34- installed as well as 3ds Max itself. Please provide the include and
35- library paths to Visual Studio.
46+ > ..\build-vs2015-x64\IfcOpenShell.sln
3647
37- For building the IfcPython wrapper, SWIG needs to be installed. Please
38- download the latest swigwin version from http://www.swig.org/download.html .
39- After extracting the .zip file, please add the extracted folder to the PATH
40- environment variable. Python needs to be installed, please provide the
41- include and library paths to Visual Studio.
48+ As the scripts default to using the ` RelWithDebInfo ` configuration, and a freshly created solution by CMake defaults
49+ to ` Debug ` , make sure to switch the used build configuration. Build the ` INSTALL ` project (right-click -> Project
50+ Only) to deploy the headers and binaries into a single location if wanted/needed.
51+
52+ Alternatively, one can use the utility batch files to build and install the project easily from the command-line:
53+
54+ > build-ifcopenshell.cmd
55+ > install-ifcopenshell.cmd
56+
57+ Alternatively, the old Visual Studio solution and project files requiring manual work can
58+ be found from the win/sln folder.
4259
4360
4461Compiling on * nix
4562=================
46- Users are advised to build IfcOpenShell using the cmake file provided in
63+ Users are advised to build IfcOpenShell using the CMake file provided in
4764the cmake/ folder. There might be an Open CASCADE package in your operating
4865system's software repository. If not, you will need to compile Open
4966CASCADE yourself. See http://opencascade.org .
146163 >>>
147164 >>> # Writing IFC-SPF files to disk:
148165 >>> f.write("out.ifc")
166+
167+ [ win/readme.md ] : https://github.com/IfcOpenShell/IfcOpenShell/tree/master/win/readme.md " win/readme.md "
0 commit comments