diff --git a/README.md b/README.md index 405b56019e56dc8609ca7852bec39a28fe351111..a1ee014fe75b6d980bdec002227e6d7fb0660a59 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