diff --git a/README.md b/README.md index db7afd9..28171a1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ This tool tries to solve the "OpenGL" problem on nix. +# Quick start + +Suppose you have a configuration with an nvidia card, host driver version `390.25` + +``` +# clone the repository +git clone https://github.com/guibou/nixGL +cd nixGL + +# build and install the wrapper +nix-build -A nixGLNvidia --argstr nvidiaVersion 390.25 +nix-env -i ./result + +# use it with any OpenGL application +nixGLNvidia blender +``` + # Motivation You use Nix on any distribution, and any GL application installed fails with this error: @@ -31,7 +48,7 @@ git clone https://github.com/guibou/nixGL cd nixGL ``` -## Optional (if NVIDIA) Grab your NVIDIA driver version +## Optional (if NVIDIA): Grab your NVIDIA driver version Using `glxinfo` from your host system, grab the driver version, here `390.25`: @@ -93,3 +110,16 @@ OpenGL version string: 4.6.0 NVIDIA 390.25 # Limitations Does not work now for AMD drivers because I dont' have the hardware. + +# Comparaison with similar tools + +[nix-install-vendor-gl.sh](https://github.com/deepfire/nix-install-vendor-gl) +provides a similar system with a different approach: + +- it auto detect the host driver +- it needs root access and set your system for a specific driver +- it only provides wrappers for nvidia (without bumblebee) + +Both projects are now really similar and the only reason I did not +contributed to `nix-install-vendor-gl.sh` was because initial `nixGL` +had a totally different approach.