diff --git a/README.md b/README.md index 829c3a268bcd3c5e53182a65d3d56f5ef51a92ff..b51c5bcd63e28b09ebd23a916e03c6e1898d09d1 100644 --- a/README.md +++ b/README.md @@ -30,3 +30,17 @@ array sizes. Stream reports the array size per array and the total memory used for the arrays. This is not a 'per cpu' memory size. The arrays are shared. + +# usage + +Call `make` to build stream compiled with GCC, with default settings +(`stream_gcc`) and with streaming stores enables (`stream_gcc_temporal`). + +If you have the AMD Optimizing C/C++ Compiler (AOCC) or Intel oneAPI DPC++/C++ Compiler +available (`aocc` and `icx`, respectively), you can build stream binaries using these +compilers by calling `make aocc` and `make icx`. + +For convenience, the `run-benchmark.sh` script builds all three versions, runs the +benchmark and stores the results in seperate files. The `make-plot.py` script can be +used to generate a plot. +