fixed example conf file for asus

[libgliar] / README

diff --git a/README b/README
index e12ff82..1efc3d0 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,28 @@
 # libgliar - a library that can fake the OpenGL context info returned by
 # the glGet OpenGL calls
 #
-# authored by: Eleni Maria Stea <elene.mst@gmail.com>
+# Copyright (C) 2013 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 
+# Author: Eleni Maria Stea <elene.mst@gmail.com>
 
 For instructions on how to build the code, see the INSTALL file.
 
 Usage:
 ------
-LD_PRELOAD=./libgliar.so <opengl_executable>
+gliar <opengl_executable>
 
 The library will read the gliar.conf file in the user's library directory or
 the .gliar.conf file in the user's home directory.
@@ -37,21 +52,12 @@ value1
 valueN
 
 Currently supported keys:
-"vendor" (the vendor string), "extensions" (the extensions string), "version" (the opengl version string)
-
-Example:
----------
-gliar.conf:
-[vendor]
-Mutant Stargoat
-
-[extensions]
-GL_MSG_hikiko_ext
-GL_MSG_test
-
-$ LD_PRELOAD=./libgliar glxinfo | grep -A2 "OpenGL extensions"
-OpenGL extensions:
-    GL_MSG_hikiko_ext, GL_MSG_test
-
+"vendor" (the vendor string), "extensions" (the list of the extensions), "version" (the opengl version string),
+"sl version" (the shading language version), "renderer" (the renderer), "max texture units", "max texture size"
 
+Example configuration files can be found in the directory examples.
+Example video: http://www.youtube.com/watch?v=v2UDGgb6AgA
 
+Note: The library can only restrict the capabilities of a GPU, not "emulate" non supported extensions for 
+example. If the gliar.conf contains an extension that is not supported by the user's real GPU, the library 
+will return a warning and the user's program might crash.