From 9087bc65a7e17a6ce9c7275dfebe16af46b26b91 Mon Sep 17 00:00:00 2001 From: Stinkfist0 Date: Sat, 14 Nov 2015 20:18:29 +0200 Subject: [PATCH] win/readme.md tweaks --- win/readme.md | 48 ++++++++++++++++++++++++++++-------------------- 1 file changed, 28 insertions(+), 20 deletions(-) diff --git a/win/readme.md b/win/readme.md index 358f972087..ee4c3c4989 100644 --- a/win/readme.md +++ b/win/readme.md @@ -1,20 +1,20 @@ Windows Build Tools and Scripts =============================== -This folder contains build tools and script for automatic building and deployment of IfcOpenShell's -(IFCOS) dependencies. +This folder contains build tools and script for automatic building and deployment of IfcOpenShell (IFCOS) +and its dependencies. As a general guideline, `.cmd` files are non-standalone batch files that need to be run from command -prompt or from other batch file and/or Visual Studio environment variables set and `.bat` files are -standalone batch files that can be run also from the File Explorer. +prompt or from another batch file, and/or while the Visual Studio environment variables set, and `.bat` files are +standalone batch files that can be run also e.g. from the File Explorer. Usage Instructions ------------------ Execute `build-deps.cmd` to fetch, build and install the dependencies. The batch file will print -requirements for a successful execution. The script allows a few user-configurable build options +the requirements for a successful execution. The script allows a few user-configurable build options which are listed in the usage instructions. Either edit the script file or set these values before 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 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` if you want to change the defaults. The batch file will create `deps\` and `deps-vs--installed\` @@ -22,29 +22,37 @@ directories to the project root. Debug and release builds of the depedencies can `build-deps.cmd Debug` and `build-deps.cmd `. After the dependencies are build, execute `run-cmake.bat`. The batch file expects a CMake generator as -`%1`, or alternatively if more parameters are provided, `%*` is passed for the CMake invokation. If no `%1` -is provided, the same default value as above is used. This batch script will create a folder of form -build-vs- which will contain the solution and project files for Visual Studio. +`%1` (if not provided, the same default value as above is used), or alternatively, if more parameters are provided, `%*` is passed for the CMake invokation, i.e., if one +wants to pass custom build options, the generator must be passed also using CMake's syntax: + +`run-cmake.bat -G "Visual Studio 14 2015 Win64" -DBUILD_IFCPYTHON=0`. + +The batch script will create a folder of form `build-vs-\` which will contain the solution and project files for Visual Studio. **If you wish to use any library from a custom location, modify the paths in run-cmake.bat accordingly**. -You can now build the project using the `IfcOpenShell.sln` file in the build folder. Build the `INSTALL` project -if wanted. The project will installed to `installed-vs-\` folder in the project's root +After this, one can build the project using the `IfcOpenShell.sln` file in the build folder. Build the `INSTALL` project +if wanted. The project will be installed to `installed-vs-\` folder in the project's root folder and the required IfcOpenShell-Python parts are deployed to the `\Lib\site-packages\` folder. -All of the dependencies are build as static libraries against the static run-time allowing the developer +**Note:** All of the dependencies are build as static libraries against the static run-time allowing the developer to effortlessly deploy standalone IFCOS binaries. Directory Structure ------------------ ``` -| build-deps.cmd - Fetches and builds all needed dependencies for IFCOS -| readme.txt - This file -| run-cmake.bat - Sets environment variables for the dependencies and runs CMake for IFCOS -| vs-cfg.cmd - Utility file used by the build scripts -| BuildDepsCache-.txt - Cache file created by build-deps.cmd -| -+---sln - Contains the old Visual Studio solution and project files -\---utils - Contains various utilities for the build scripts +.. ++---build-vs- - Created by run-cmake.bat, for a certain VS version and target architecture ++---deps - Created by build-deps.cmd, common for all VS versions and target architectures ++---deps-installed-vs- - Created by build-deps.cmd, for a certain VS version and target architecture ++---installed-vs- - Created by building the IFCOS's INSTALL project +\---win +| build-deps.cmd - Fetches and builds all needed dependencies for IFCOS +| BuildDepsCache-.txt - Cache file created by build-deps.cmd +| readme.md - This file +| run-cmake.bat - Sets environment variables for the dependencies and runs CMake for IFCOS +| vs-cfg.cmd - Utility file used by the build scripts ++---sln - Contains the old Visual Studio solution and project files +\---utils - Contains various utilities for the build scripts ```