From 68d2d179fa9b967a32818f104657e17cbf4e87f9 Mon Sep 17 00:00:00 2001
From: Bram Veenboer <bram.veenboer@gmail.com>
Date: Fri, 30 Jun 2023 17:10:31 +0200
Subject: [PATCH] Update README

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 829c3a2..b51c5bc 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.
+
-- 
GitLab