1These are the instructions to build QuesoGLC on POSIX platforms. If you want to
2build QuesoGLC on Windows, see INSTALL.win
3
41. What do you need in order to build QuesoGLC :
5================================================
6
71.1 Tools/headers/libraries that are mandatory :
8------------------------------------------------
9
10QuesoGLC depends on tools and libraries that are now widely used in the
11Open Source world, and which might already be installed on your favorite
12platform. If not, you can get them on Internet and build them on your system.
13
14* OpenGL, GLU (www.opengl.org/documentation/implementations.html)
15	QuesoGLC is supposed to provide a character rendering service for
16	OpenGL. Hence you definitely need OpenGL ;-)
17* FreeType2 (www.freetype.org)
18	This is the core lib that manage fonts files and datas. QuesoGLC heavily
19	uses its functionnalities.
20* Fontconfig (www.fontconfig.org)
21	Fontconfig is a library for font customization and configuration. It is
22	used by QuesoGLC to automagically detect the fonts that are available
23	on your system.
24* POSIX threads
25	GLC is designed with core support for multi-threading. However,
26	QuesoGLC only supports POSIX threads. 'pthread' lib and headers are
27	mandatory in order to build QuesoGLC.
28* GNU Make tool (www.gnu.org/software/make/make.html)
29	QuesoGLC's build process heavily rely on this tool. You must install it
30	first.
31
321.2 Tools/headers/libraries that are optional :
33-----------------------------------------------
34
35QuesoGLC can be safely built and used without GLUT. However, some test programs
36need GLUT in order to display OpenGL graphics : if GLUT is not installed on your
37system, the examples will not build.
38Doxygen is a tool to generate the docs, you need it if you want to generate the
39documentation yourself; otherwise you can get the reference manual of QuesoGLC
40by either downloading it from SourceForge or browsing it on-line on the QuesoGLC
41web site (http://quesoglc.sourceforge.net).
42
43* Mark Kilgard's GLUT (www.opengl.org/resources/libraries/glut.html)
44	It provides platform independant support for OpenGL.
45* Doxygen (www.stack.nl/~dimitri/doxygen)
46	A documentation system for several language (including C) that
47	generates the on-line documentation (in HTML) and the off-line
48	reference manual (in Latex/PDF/HTML) of QuesoGLC
49
502. OK, all those libs and headers are installed on my machine.
51What shall I do now ?
52==============================================================
53
542.1. Build the library and the examples :
55-----------------------------------------
56
57Simply type
58
59  ./configure
60  make
61  make install
62
63on the command line to configure, build and install QuesoGLC on your
64system. Note that the default installation path is "/usr/local". If you want to
65install QuesoGLC to another location, use the --prefix option of configure :
66
67  ./configure --prefix=/another/location
68
69By default, both the static and the dynamic library are built, but if you only
70want the static library you can use the --disable-shared option of the
71configure script :
72
73  ./configure --disable-shared
74
75For more informations about the options of the configure script, just type :
76
77  ./configure --help
78
792.2 Build the docs (optional) :
80-------------------------------
81
82You may also want to build the documentation; QuesoGLC uses Doxygen that does
83the job nicely. In order to get the docs, go to the docs/ directory and run
84Doxygen:
85
86  cd docs
87  doxygen
88
89This should build the docs in HTML and Latex/PDF (the later needs latex and
90pdflatex to be installed on your system).
91
923. Is that all ?
93================
94
95When the library has been successfully built, you might define the environment
96variable GLC_PATH in order to indicate QuesoGLC where to find fonts. This step
97is optional since QuesoGLC uses Fontconfig to locate the fonts on your system.
98You can however add some additional directories to those detected by Fontconfig.
99
100GLC_PATH is a colon-separated list of directories similar to the PATH
101environment variable. Depending on your shell the command is either
102
103export GLC_PATH=/usr/lib/X11/fonts/Type1:/path/to/another/font/directory
104
105or
106
107setenv GLC_PATH /usr/lib/X11/fonts/Type1:/path/to/another/font/directory
108
109Note : the path /usr/lib/X11/fonts/Type1 usually leads to Type1 fonts on almost
110all X-window flavor.
111
1124. Is that really all ?
113=======================
114
115You should have a look at the README file and at the documentation, especially
116at the tutorials. You can also get the specifications of GLC from
117www.opengl.org/documentation/specs/glc/glcspec.ps. You should also try the tests
118and example programs too.
119