changelog updates

80db71fc · Lisa Delaney · 1d34a197 · 80db71fc · 80db71fc
Commit 80db71fc authored Nov 02, 2023 by Lisa Delaney
Expand all Hide whitespace changes
Inline Side-by-side

Showing with 365 additions and 223 deletions

CHANGELOG.md CHANGELOG.md +349 -211

README.md README.md +16 -12

No files found.
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
--- a/README.md
+++ b/README.md
 # TransferBench

-TransferBench is a simple utility capable of benchmarking simultaneous copies between user-specified devices (CPUs/GPUs).
+TransferBench is a simple utility capable of benchmarking simultaneous copies between user-specified
+CPU and GPU devices.

 ## Requirements

@@ -20,18 +21,21 @@ python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```

 ## Building
+
  To build TransferBench using Makefile:
- ```shell
- $ make
- ```
-
-  To build TransferBench using cmake:
- ```shell
-$ mkdir build
-$ cd build
-$ CXX=/opt/rocm/bin/hipcc cmake ..
-$ make
- ```
+
+```shell
+make
+```
+
+To build TransferBench using CMake:
+
+```shell
+mkdir build
+cd build
+CXX=/opt/rocm/bin/hipcc cmake ..
+make
+```

  If ROCm is installed in a folder other than `/opt/rocm/`, set ROCM_PATH appropriately