diff --git a/INSTALL.md b/INSTALL.md index 0ac95f87554..f29ceb36beb 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -9,9 +9,10 @@ ## Configure oneTBB -At the command prompt, type: -``` -cmake +In your build directory, type: + +```bash +cmake [options] ``` You may want to use some additional options for configuration: @@ -25,8 +26,9 @@ You may want to use some additional options for configuration: ## Build oneTBB To build the system, run: -``` -cmake --build . + +```bash +cmake --build . [options] ``` Some useful build options: @@ -73,7 +75,7 @@ Simple packaging using CPack is supported. The following commands allow you to create a simple portable package that includes header files, libraries, and integration files for CMake: ```bash -cmake .. +cmake [options] .. cpack ``` diff --git a/cmake/README.md b/cmake/README.md index 60df73c0725..3d9884f77c1 100644 --- a/cmake/README.md +++ b/cmake/README.md @@ -26,7 +26,7 @@ TBB_BUILD_APPLE_FRAMEWORKS - Enable the Apple* frameworks instead of dylibs, onl ### Preparation -To perform an out-of-source build, create a build directory and go there: +To perform an out-of-source build, create a build directory in an arbitrary location outside of the oneTBB source directory and go there. ```bash mkdir /tmp/my-build @@ -35,8 +35,10 @@ cd /tmp/my-build ### Configure +In the build directory, specify the oneTBB source directory to generate a build system for it. + ```bash -cmake +cmake [options] ``` Some useful options: @@ -47,7 +49,7 @@ Some useful options: > **_TIP:_** It is recommended to install the HWLOC* library. See [oneTBB documentation](https://oneapi-src.github.io/oneTBB/GSG/next_steps.html#hybrid-cpu-and-numa-support) for details. -The TBBbind library has three versions: `tbbbind`, `tbbbind_2_0`, and `tbbbind_2_5`. Each of these versions is linked with the corresponding HWLOC* library version: +The TBBbind library has three versions: `tbbbind`, `tbbbind_2_0`, and `tbbbind_2_5`. Each of these versions is linked with the corresponding HWLOC* library version: - `tbbbind` links with `HWLOC 1.11.x` - `tbbbind_2_0` links with `HWLOC 2.1–2.4` - `tbbbind_2_5` links with `HWLOC 2.5` and later