1These are the instructions to build QuesoGLC on Windows, if you want to build
2QuesoGLC on POSIX platforms, see INSTALL. If you just want the binaries, DLL,
3headers and import files, a precompiled package is available at
4http://sourceforge.net/projects/quesoglc.
5
61. What do you need in order to build QuesoGLC :
7================================================
8
91.1 Tools/headers/libraries that are mandatory :
10------------------------------------------------
11
12QuesoGLC depends on tools and libraries that are now widely used in the
13Open Source world, and which might already be installed on your favorite
14platform. If not, you can get them on Internet or build them on your system.
15
16* OpenGL, GLU (www.opengl.org/documentation/implementations.html)
17	QuesoGLC is supposed to provide a character rendering service for
18	OpenGL. Hence you definitely need OpenGL ;-) You must check that
19	opengl32.dll and glu32.dll are installed in your system directory (which
20	may be either C:\Windows\System, C:\Winnt\System32 or
21	C:\Windows\System32)
22	otherwise you must download them at
23	http://download.microsoft.com/download/win95upg/info/1/w95/en-us/opengl95.exe
24* FreeType2 (www.freetype.org)
25	This is the core lib that manage fonts files and datas. QuesoGLC heavily
26	uses its functionnalities. You can find a precompiled DLL at
27	http://gnuwin32.sourceforge.net/packages/freetype.htm
28* Fontconfig (www.fontconfig.org)
29	Fontconfig is a library for font customization and configuration. It is
30	used by QuesoGLC to automagically detect the fonts that are available
31	on your system. You can find a precompiled DLL at
32	http://www.gimp.org/~tml/gimp/win32/downloads.html
33	Fontconfig needs expat (http://expat.sourceforge.net) which an XML
34	parser. You can download it at the sourceforge site but for some reason
35	the authors decided to change the name of the DLL, so fontconfig may
36	complain that it can not find 'xmlparse.dll'. Just rename expat.dll to
37	xmlparse.dll will do the trick.
38* MinGW32 tools including the make tool (www.mingw.org)
39	The package name MinGW 5.0.3 or likely contains all you need. Download
40	it and install it.
41
421.2 Tools/headers/libraries that are optional :
43-----------------------------------------------
44
45QuesoGLC can be safely built and used without GLUT. However, some test programs
46need GLUT in order to display OpenGL graphics : if GLUT is not installed on your
47system, the examples will not build.
48Doxygen is a tool to generate the docs, you need it if you want to generate the
49documentation yourself; otherwise you can get the reference manual of QuesoGLC
50by either downloading it from SourceForge or browsing it on-line on the QuesoGLC
51web site (http://quesoglc.sourceforge.net).
52
53* Mark Kilgard's GLUT (www.opengl.org/resources/libraries/glut.html)
54	It provides platform independant support for OpenGL. The DLL, lib and
55	headers can be downloaded at http://www.xmission.com/~nate/glut.html.
56	Do not forget to read cautiously the instruction about GLUT at the MinGW
57	site (http://www.mingw.org/MinGWiki/index.php/Glut).
58* Doxygen (www.stack.nl/~dimitri/doxygen)
59	A documentation system for several language (including C) that
60	generates the on-line documentation (in HTML) and the off-line
61	reference manual (in Latex/PDF/HTML) of QuesoGLC
62
632. OK, all those libs and headers are installed on my machine.
64What shall I do now ?
65==============================================================
66
672.1 First make sure that the MinGW binaries are in your PATH :
68--------------------------------------------------------------
69
70If you installed MinGW in the directory C:\MinGW then you must check that
71C:\MinGW\bin is in your PATH. Type :
72
73  echo %PATH%
74
75and if C:\MinGW\bin is not listed in the PATH, then you must add it :
76
77  set PATH=%PATH%;C:\MinGW\bin
78
79Of course, if you installed MinGW elsewhere then you must change C:\MinGW\bin
80in the command above by the relevant path.
81
822.2 Edit the makefile in order to make it suit your needs :
83-----------------------------------------------------------
84
85You may need to change some of the parameters depending on your installation of
86the above mentionned tools and libraries. The parameters are prepended by
87comments that are self explanatory, let them guide you. The makefile is named
88'makefile.mgw' (without the quotes as usual).
89
902.3 Build the library and the examples :
91----------------------------------------
92
93At least, you have reached the point where you can build the whole stuff.
94Just run the makefile :
95
96  mingw32-make -f makefile.mgw
97
98It should build everything. Before you try to run the tests, make sure that the
99DLLs (including QuesoGLC's) are either in the same directory than your
100executables or in the system directory (C:\Windows\System or similar).
101
1022.4 Build the docs (optional) :
103-------------------------------
104
105You may also want to build the documentation; QuesoGLC uses Doxygen that does
106the job nicely. In order to get the docs, go to the docs/ directory and run
107Doxygen:
108
109  cd docs
110  doxygen.exe
111
112This should build the docs in HTML and Latex/PDF (the later needs latex and
113pdflatex to be installed on your system).
114
1153. Is that all ?
116================
117
118When the library has been successfully built, you might define the environment
119variable GLC_PATH in order to indicate QuesoGLC where to find fonts. This step
120is optional since QuesoGLC uses Fontconfig to locate the fonts on your system.
121You can however add some additional directories to those detected by Fontconfig.
122
123GLC_PATH is a semicolon-separated list of directories similar to the PATH
124environment variable. Depending on your shell the command is either
125
126set GLC_PATH=C:\Windows\fonts;C:\whatever\path\to\another\font\directory
127
128Note : the path C:\Windows\fonts usually leads to every fonts installed on your
129system.
130
1314. Is that really all ?
132=======================
133
134You should have a look at the README file and at the documentation, especially
135at the tutorials. You can also get the specifications of GLC from
136www.opengl.org/documentation/specs/glc/glcspec.ps. You should also try the tests
137and example programs too.
138