aboutsummarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..9258d947f9d2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# amdgpocl
+OpenCL on amdgpu for Arch
+
+This package allows the usage of AMD's proprietary user-space OpenCL driver along with the free amdgpu stack. It should work with upstream amdgpu and Mesa. Inspired by [this blog post](http://www.gearsongallium.com/?p=2960).
+
+## Hardware support
+
+This *should* work with all amdgpu-enabled GCN GPUs. However, I have no hardware to actually test it.
+
+If you are using CIK (Sea Islands GPU), you'll need a custom kernel. Check the [aur](https://aur.archlinux.org/packages/linux-cik/) or compile your own.
+
+Currently tested with Kernel 4.8.6 and Hawaii. Blender Cycles and Luxmark seem to work without any problems.
+
+## What this is not
+
+You are not getting Vulkan support, faster 3D rendering or unicorns.
+
+If you are looking for the full amdgpu-pro stack, including proprietary OpenGL and Vulkan implementations, move over to the [aur](https://aur.archlinux.org/pkgbase/amdgpu-pro-installer/).
+
+Expect maintainance of this package to be dropped when there is free OpenCL support on top of the [ROC](https://radeonopencompute.github.io/) stack.