Skip to content

Align README source build with docs #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harkgill-amd merged 1 commit into from
Nov 6, 2025
Merged

Align README source build with docs #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,32 @@ See the [full library and API documentation](https://rocm.docs.amd.com/en/latest

### Build from Source

See [Build from Source](#Build_from_Source)
See [Build from Source](https://rocm.docs.amd.com/projects/rocm_bandwidth_test/en/latest/install/install.html#building-rbt-from-source)

```bash
git clone https://github.com/ROCm/rocm_bandwidth_test
cd rocm_bandwidth_test
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug|Release
make

## Standalone build
cmake -DCMAKE_BUILD_TYPE="Debug | Release" .. \
-DAMD_APP_STANDALONE_BUILD_PACKAGE=ON \
-DAMD_APP_ENGINEERING_BUILD_PACKAGE=OFF && cmake --build .

## ROCm build
## Assumes ROCm is installed on the build system
cmake -DCMAKE_BUILD_TYPE="Debug | Release" .. \
-DAMD_APP_STANDALONE_BUILD_PACKAGE=OFF \
-DAMD_APP_ROCM_BUILD_PACKAGE=ON && cmake --build .
```

## Installing RBT
```bash
## For Makefiles
make install

## For CMake; Default install location is /opt/rocm/
cmake --install . --prefix /path/to/install/location
```

## Usage
Expand Down