mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-09-20 23:36:20 +00:00
Update READMEs.
This commit is contained in:
@@ -1,11 +1,16 @@
|
|||||||
IfcOpenShell
|
IfcOpenShell
|
||||||
============
|
============
|
||||||
open source (LGPL) software library for working with the IFC file format
|
Open source (LGPL) software library for working with the IFC file format.
|
||||||
|
|
||||||
[http://ifcopenshell.org](http://ifcopenshell.org)
|
[http://ifcopenshell.org](http://ifcopenshell.org)
|
||||||
[http://academy.ifcopenshell.org](http://academy.ifcopenshell.org)
|
[http://academy.ifcopenshell.org](http://academy.ifcopenshell.org)
|
||||||
|
|
||||||
|
|
||||||
|
Prerequisites
|
||||||
|
=============
|
||||||
|
* Git, CMake (2.6 or newer), Visual Studio 2008 or newer (Windows), or GCC (*nix, Clang untested).
|
||||||
|
|
||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
============
|
============
|
||||||
* [Boost](http://www.boost.org/)
|
* [Boost](http://www.boost.org/)
|
||||||
@@ -18,32 +23,34 @@ Dependencies
|
|||||||
For IfcConvert to be able to write tessellated Collada (.dae) files
|
For IfcConvert to be able to write tessellated Collada (.dae) files
|
||||||
* [SWIG](http://www.swig.org/), [Python](https://www.python.org/) libraries *optional*
|
* [SWIG](http://www.swig.org/), [Python](https://www.python.org/) libraries *optional*
|
||||||
For building the IfcOpenShell Python interface and the Blender add-on
|
For building the IfcOpenShell Python interface and the Blender add-on
|
||||||
* 3ds max SDK *optional*
|
* 3ds Max SDK *optional*
|
||||||
For building the 3ds max plug-in
|
For building the 3ds Max plug-in
|
||||||
|
|
||||||
|
|
||||||
Compiling on Windows
|
Compiling on Windows
|
||||||
====================
|
====================
|
||||||
Users are advised to use the Visual Studio .sln file in the win/ folder.
|
Users are advised to build IfcOpenShell using the CMake file provided in
|
||||||
For Windows users a prebuilt Open CASCADE version is available from the
|
the cmake/ folder.
|
||||||
http://opencascade.org website. Download and install this version and
|
|
||||||
provide the paths to the Open CASCADE header and library files to MS
|
|
||||||
Visual Studio C++.
|
|
||||||
|
|
||||||
For building the Autodesk 3ds Max plugin, the 3ds Max SDK needs to be
|
The preferred way to fetch and build this project's dependencies is to use the build scripts
|
||||||
installed as well as 3ds Max itself. Please provide the include and
|
in win/ folder. See win/readme.txt for more information. Instructions in a nutshell
|
||||||
library paths to Visual Studio.
|
(assuming Visual Studio x64 environment variables set):
|
||||||
|
> git clone https://github.com/Tridify/IfcOpenShell.git
|
||||||
|
> cd oce\win
|
||||||
|
> build-deps.cmd (defaults to using VS 2015 x64 RelWithDebInfo build)
|
||||||
|
> run-cmake.bat (defaults to using VS 2015 x64)
|
||||||
|
> copy-runtime-deps.bat (defaults to using RelWithDebInfo)
|
||||||
|
> ..\build-vs2015-x64\IfcOpenShell.sln
|
||||||
|
You can now build the solution using the RelWithDebInfo configuration
|
||||||
|
You can also build the INSTALL project if wanted
|
||||||
|
|
||||||
For building the IfcPython wrapper, SWIG needs to be installed. Please
|
Alternatively, the old Visual Studio solution and project files requiring manual work can
|
||||||
download the latest swigwin version from http://www.swig.org/download.html.
|
be found from the win/sln folder.
|
||||||
After extracting the .zip file, please add the extracted folder to the PATH
|
|
||||||
environment variable. Python needs to be installed, please provide the
|
|
||||||
include and library paths to Visual Studio.
|
|
||||||
|
|
||||||
|
|
||||||
Compiling on *nix
|
Compiling on *nix
|
||||||
=================
|
=================
|
||||||
Users are advised to build IfcOpenShell using the cmake file provided in
|
Users are advised to build IfcOpenShell using the CMake file provided in
|
||||||
the cmake/ folder. There might be an Open CASCADE package in your operating
|
the cmake/ folder. There might be an Open CASCADE package in your operating
|
||||||
system's software repository. If not, you will need to compile Open
|
system's software repository. If not, you will need to compile Open
|
||||||
CASCADE yourself. See http://opencascade.org.
|
CASCADE yourself. See http://opencascade.org.
|
||||||
|
|||||||
+1
-1
@@ -16,7 +16,7 @@ which are listed in the usage instructions. Either edit the script file or set t
|
|||||||
running the script.
|
running the script.
|
||||||
|
|
||||||
build-deps.cmd expects a CMake generator as %1 and a build configuration type as %2. If the parameters
|
build-deps.cmd expects a CMake generator as %1 and a build configuration type as %2. If the parameters
|
||||||
are not provided, the default values are used ("Visual Studio 12 Win64" and RelWithDebInfo respectively).
|
are not provided, the default values are used ("Visual Studio 14 2015 Win64" and RelWithDebInfo respectively).
|
||||||
A build type (Build/Rebuild/Clean) can be provided as %3, if wanted (defaults to Build). See vs-cfg.cmd
|
A build type (Build/Rebuild/Clean) can be provided as %3, if wanted (defaults to Build). See vs-cfg.cmd
|
||||||
if you want to change the defaults. The batch file will create deps\ and deps-vs<VERSION>-<ARCHITECTURE>-installed\
|
if you want to change the defaults. The batch file will create deps\ and deps-vs<VERSION>-<ARCHITECTURE>-installed\
|
||||||
directories to the project root. Note that currently only libraries for one build configuration type
|
directories to the project root. Note that currently only libraries for one build configuration type
|
||||||
|
|||||||
@@ -0,0 +1,16 @@
|
|||||||
|
Original information from the README.md:
|
||||||
|
|
||||||
|
For Windows users a prebuilt Open CASCADE version is available from the
|
||||||
|
http://opencascade.org website. Download and install this version and
|
||||||
|
provide the paths to the Open CASCADE header and library files to MS
|
||||||
|
Visual Studio C++.
|
||||||
|
|
||||||
|
For building the Autodesk 3ds Max plugin, the 3ds Max SDK needs to be
|
||||||
|
installed as well as 3ds Max itself. Please provide the include and
|
||||||
|
library paths to Visual Studio.
|
||||||
|
|
||||||
|
For building the IfcPython wrapper, SWIG needs to be installed. Please
|
||||||
|
download the latest swigwin version from http://www.swig.org/download.html.
|
||||||
|
After extracting the .zip file, please add the extracted folder to the PATH
|
||||||
|
environment variable. Python needs to be installed, please provide the
|
||||||
|
include and library paths to Visual Studio.
|
||||||
Reference in New Issue
Block a user