From eafab99fd627404e3b0f0a5319e1b68ad24c962f Mon Sep 17 00:00:00 2001 From: Oliver Bock <oliver.bock@aei.mpg.de> Date: Tue, 7 Jun 2016 15:46:39 +0200 Subject: [PATCH] Added README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b89884 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Prerequisites + +* Supported operating systems: + * Linux + * Mac OS X + * Windows (via cross-compilation on Linux using MinGW) +* Supported GPUs: + * AMD GPU with installed drivers + * NVIDIA GPU with installed drivers +* Supported OpenCL SDKs: + * AMD APP SDK: installation root exported in environment variable `AMDAPPSDKROOT ` + * NVIDIA CUDA Toolkit: installation root exported in environment variable `NVIDIA_SDK_INSTALL_PATH` + +# Build instructions + +The codebase contains a top-level Makefile that builds the library and the example, providing the following build targets: + +* linux (default) +* macos +* win32 +* win64 +* clean + +# Usage + +* Library +* Example -- GitLab