changed readme to include the new strings
[libgliar] / README
1 # libgliar - a library that can fake the OpenGL context info returned by
2 # the glGet OpenGL calls
3 #
4 # Copyright (C) 2013 Canonical Ltd
5 #
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19 # Author: Eleni Maria Stea <elene.mst@gmail.com>
20
21 For instructions on how to build the code, see the INSTALL file.
22
23 Usage:
24 ------
25 LD_PRELOAD=./libgliar.so <opengl_executable>
26
27 The library will read the gliar.conf file in the user's library directory or
28 the .gliar.conf file in the user's home directory.
29
30 Example gliar.conf:
31 -------------------
32 [key1]
33 value1
34 value2
35 .
36 .
37 .
38 valueN
39
40 [key2]
41 value1
42 .
43 .
44 .
45 valueN
46
47 [keyN]
48 value1
49 .
50 .
51 .
52 valueN
53
54 Currently supported keys:
55 "vendor" (the vendor string), "extensions" (the extensions string), "version" (the opengl version string),
56 "sl version" (the shading language version), "renderer" (the renderer)
57
58 Example:
59 ---------
60 gliar.conf:
61 [vendor]
62 Mutant Stargoat
63
64 [extensions]
65 GL_MSG_hikiko_ext
66 GL_MSG_test
67
68 $ LD_PRELOAD=./libgliar glxinfo | grep -A2 "OpenGL extensions"
69 OpenGL extensions:
70     GL_MSG_hikiko_ext, GL_MSG_test
71
72
73