From 98a60f1f328dd7b5470eab068609d6d0050666c4 Mon Sep 17 00:00:00 2001
From: Bram Veenboer <bram.veenboer@gmail.com>
Date: Fri, 6 Oct 2023 13:37:02 +0200
Subject: [PATCH] Update readme

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

diff --git a/README.md b/README.md
index 405b560..a1ee014 100644
--- a/README.md
+++ b/README.md
@@ -97,4 +97,18 @@ srun -N 1 --gres=gpu:A4000:1 make -C build test
 
 Note that in the command above a node with a NVIDIA A4000 GPU is requested, because the tests require a GPU that has tensor cores.
 
+## Example usage
+The `example` subdirectory has a minimal example that demonstrates how this
+library can be integrated in another project. This example assumes that you
+pre-installed both this library (`libtcc`) and `cudawrappers`. E.g. when
+`libtcc` is installed in `<prefix>/libtcc` and `cudawrappers` is installed in
+`<prefix>/cudawrappers`, you can build the example by running:
+```bash
+cmake . -DCMAKE_PREFIX_PATH="<prefix>/cudawrappers;<prefix>/tcc"
+make
+./example
+```
+
+
+## Bugs/feedback
 Contact John Romein (romein@astron.nl) to report bugs/feedback
-- 
GitLab