diff --git a/README.md b/README.md index f525e39..112e53b 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,20 @@ # vgpu\_unlock -Unlock vGPU functionality for consumer grade GPUs. +Unlock vGPU functionality for consumer-grade Nvidia GPUs. ## Important! -This tool is very untested, use at your own risk. +This tool is not guarenteed to work out of the box in some cases, so use it at your own risk. ## Description This tool enables the use of Geforce and Quadro GPUs with the NVIDIA vGPU -software. NVIDIA vGPU normally only supports a few Tesla GPUs but since some -Geforce and Quadro GPUs share the same physical chip as the Tesla this is only -a software limitation for those GPUs. This tool aims to remove this limitation. +software. NVIDIA vGPU normally only supports a few datacenter Tesla and professional Quadro GPUs by design, +but not consumer graphics cards through a software limitation. This tool aims to remove this limitation. + +A community maintained Wiki written by Krutav Shah with a lot more information is [available here.](https://docs.google.com/document/d/1pzrWJ9h-zANCtyqRgS7Vzla0Y8Ea2-5z2HEi4X75d2Q/edit?usp=sharing) ## Dependencies: @@ -49,7 +50,7 @@ systemctl daemon-reload ``` Modify the file `/usr/src/nvidia-/nvidia/os-interface.c` and add the -following line after the lines begining with `#include` at the start of the +following line after the lines begining with `#include` at the beginning of the file. ``` #include "/vgpu_unlock_hooks.c" @@ -76,9 +77,11 @@ Reboot. --- **NOTE** -This script will only work if there exists a vGPU compatible Tesla GPU that -uses the same physical chip as the actual GPU being used. - +This script only works with graphics cards in the same generation as their professional Tesla counterparts. +As a result, only Maxwell and newer generation Nvidia GPUs are supported. It is not designed to be used with +low end graphics card models, so not all cards are guarenteed to work smoothly with vGPU. For the best experience, +it is recommended to use graphics cards with the same chip model as the Tesla cards. The same applies to the +operating system as well, as certain bleeding-edge Linux distributions may not work well with vGPU software. ---