Documenting support for Open Watcom
[freeglut] / README.win32
1 Windows 32 Notes
2 ================
3
4 The "freeglut" library installation package comes with MSVC 6.0 workspace and
5 project files.  The workspace "freeglut.dsw" has two projects:
6 "freeglut.dsp", which creates a DLL file, and "freeglut_static.dsp", which
7 creates a static library.
8
9 The "freeglut" library also comes with an Open Watcom compiler project file
10 "freeglut.wpj" and two target files "freeglut.tgt" and "freeglut_static.tgt".
11 The two target files build DLL and static libraries.  The Open Watcom also
12 includes "freeglut.rc", which is a resource compiler script to add a "Version"
13 tab to the DLL property sheet.
14
15
16 Building the Libraries with MSVC
17 ================================
18
19 To build the "freeglut" libraries, open MSVC and load the "freeglut" workspace.
20 This will load the two projects.  Selecting "Build" - "Batch Build" from the
21 menu will build both the debug and the release versions of both libraries.
22
23 The libraries will be found in the following places and will have the
24 following names:
25 - DLL, debug version: freeglut\freeglut\Debug\freeglut.lib
26 - DLL, release version: freeglut\freeglut\Release\freeglut.lib
27 - Static, debug version: freeglut\freeglut\DebugStatic\freeglut_static.lib
28 - Static, release version: freeglut\freeglut\ReleaseStatic\freeglut_static.lib
29
30 Unlike the *nix release, the library names are NOT automatic replacements for
31 the GLUT library names.  You may rename them manually if you wish, but this is
32 not necessary as the header file includes a pragma telling the compiler which
33 library file to look for.
34
35
36 Installing the Libraries with MSVC
37 ==================================
38
39 To install "freeglut" on your system so that your other projects will see it,
40 you will need to copy various files to various locations.
41
42     - The header files "freeglut.h", "freeglut_ext.h", "freeglut_std.h", and
43       "glut.h" (distributed in the directory "freeglut\freeglut\include\GL")
44       need to be copied to a "GL" directory under the MSVC include directory.
45       The MSVC include directory generally has a path similar to
46               "C:\Program Files\Microsoft Visual Studio\VC98\Include"
47       The "GL" subdirectory under that will probably already have the header
48       files "gl.h", "glaux.h", and "glu.h".
49     - The library file "freeglut.lib" or "freeglut_static.lib" (from the
50       corresponding debug or release directory) needs to be copied into the
51       MSVC library directory.  This usually has a path similar to
52               "C:\Program Files\Microsoft Visual Studio\VC98\Lib"
53       Note that there is no "GL" subdirectory here.  This directory should
54       already have the files "opengl32.lib", "glu32.lib", and "glaux.lib".
55     - If you are using the DLL version of "freeglut", the file "freeglut.dll"
56       needs to be copied from the Debug or the Release directory into the
57       DLL directory.  This usually has a path similar to
58               "C:\Windows\System32"
59       and will probably already have the files "opengl32.dll" and "glu32.dll".
60
61
62 Building and Installing the Libraries with Open Watcom
63 ======================================================
64
65 To build the "freeglut" libraries, open Watcom and load the "freeglut.wpj"
66 file.  This will load the two target files.  Clicking on the "Make All
67 Targets" button will build both the debug and the release versions of both
68 libraries.
69
70 The "make" script will copy the library files to the Open Watcom library
71 folder and will copy "freeglut.dll" to the correct "System32" folder.  The
72 library files are named "freeglut.lib" for the DLL version and
73 "freeglut_static.lib"for the static library.
74
75 You will need to copy the "freeglut" include files from their installed
76 location ("freeglut\freeglut\include\GL") to the Open Watcom include directory
77 ("%WATCOM%\h\nt\GL").
78
79 Unlike the *nix release, the library names are NOT automatic replacements for
80 the GLUT library names.  You may rename them manually if you wish, but this is
81 not necessary as the header file includes a pragma telling the compiler which
82 library file to look for.
83
84
85 If you don't have MSVC or Open Watcom
86 =====================================
87
88 The "freeglut" developers' community discussed the possibility of distributing
89 binaries and decided against it.  If you need Windows library files, please
90 contact John F. Fay at <john.fay@eglin.af.mil> or put a request on the
91 "freeglut" developers' mailing list <freeglut-developer@lists.sourceforge.net>.
92