README.md 807 Bytes
Newer Older
Oliver Bock's avatar
Oliver Bock committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 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
Bernd Machenschalk's avatar
Bernd Machenschalk committed
22
* install
Oliver Bock's avatar
Oliver Bock committed
23
24
* clean

Bernd Machenschalk's avatar
Bernd Machenschalk committed
25
26
The `install` target uses the `PREFIX` variable, i.e. you should use `PREFIX=/some/path make install` or `make install PREFIX=/some/path`

Oliver Bock's avatar
Oliver Bock committed
27
28
29
30
# Usage

* Library
* Example