Skip to content

Commit

Permalink
Improve cmake README and INSTALL docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ChihweiLHBird committed Jul 16, 2024
1 parent 1f52f50 commit 1ad310a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
14 changes: 8 additions & 6 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@

## Configure oneTBB

At the command prompt, type:
```
cmake <options> <repo_root>
In your build directory, type:

```bash
cmake [options] <repo_root>
```

You may want to use some additional options for configuration:
Expand All @@ -25,8 +26,9 @@ You may want to use some additional options for configuration:
## Build oneTBB

To build the system, run:
```
cmake --build . <options>

```bash
cmake --build . [options]
```

Some useful build options:
Expand Down Expand Up @@ -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 <options> ..
cmake [options] ..
cpack
```

Expand Down
8 changes: 5 additions & 3 deletions cmake/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <options> <repo_root>
cmake [options] <repo_root>
```

Some useful options:
Expand All @@ -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
Expand Down

0 comments on commit 1ad310a

Please sign in to comment.