Applying the "readme-win32.patch" patch from Diederick Niehorster in e-mail dated...
[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 Starting with VS2008, these libraries can instead be found at:
31 - DLL, debug version:       freeglut\freeglut\lib\Debug\freeglut.lib
32                             freeglut\freeglut\lib\Debug\freeglut.dll
33 - DLL, release version:     freeglut\freeglut\lib\Release\freeglut.lib
34                             freeglut\freeglut\lib\Release\freeglut.dll
35 - Static, debug version:    freeglut\freeglut\lib\Debug\freeglut_static.lib
36 - Static, release version:  freeglut\freeglut\lib\Release\freeglut_static.lib
37
38 Unlike the *nix release, the library names are NOT automatic replacements for
39 the GLUT library names.  You may rename them manually if you wish, but this is
40 not necessary as the header file includes a pragma telling the compiler which
41 library file to look for.
42
43
44 Installing the Libraries with MSVC
45 ==================================
46
47 To install "freeglut" on your system so that your other projects will see it,
48 you will need to copy various files to various locations.
49
50     - The header files "freeglut.h", "freeglut_ext.h", "freeglut_std.h", and
51       "glut.h" (distributed in the directory "freeglut\freeglut\include\GL")
52       need to be copied to a "GL" directory under the MSVC include directory.
53       The MSVC include directory generally has a path similar to
54               "C:\Program Files\Microsoft Visual Studio\VC98\Include"
55       The "GL" subdirectory under that will probably already have the header
56       files "gl.h", "glaux.h", and "glu.h".
57     - The library file "freeglut.lib" or "freeglut_static.lib" (from the
58       corresponding debug or release directory) needs to be copied into the
59       MSVC library directory.  This usually has a path similar to
60               "C:\Program Files\Microsoft Visual Studio\VC98\Lib"
61       Note that there is no "GL" subdirectory here.  This directory should
62       already have the files "opengl32.lib", "glu32.lib", and "glaux.lib".
63     - If you are using the DLL version of "freeglut", the file "freeglut.dll"
64       needs to be copied from the Debug or the Release directory into the
65       DLL directory.  This usually has a path similar to
66               "C:\Windows\System32"
67       and will probably already have the files "opengl32.dll" and "glu32.dll".
68
69 The "VisualStudio2008" and "VisualStudio2008Static" directories are DEPRECATED
70 as of January 22, 2011.  Users are directed to the "VisualStudio\2008" directory
71 instead.
72
73
74 Building and Installing the Libraries with Open Watcom
75 ======================================================
76
77 Start a command prompt and change directory to the freeglut installation
78 directory.  Type "wmake -f Makefile.wat all" to build the DLL and static
79 libraries in both debug and release versions.
80
81 To install "freeglut" on your system so that your other projects will see it,
82 you will need to copy various files to various locations.
83
84     - The header files "freeglut.h", "freeglut_ext.h", "freeglut_std.h", and
85       "glut.h" (distributed in the directory "freeglut\freeglut\include\GL")
86           need to be copied to a "GL" directory under the Open Watcom 32-bit
87           Windows include directory.  This usually has a path similar to
88                           "C:\WATCOM\h\nt\GL"
89     - The library file "freeglut.lib" or "freeglut_static.lib" (from the
90       corresponding debug or release directory) needs to be copied into the
91           Open Watcom 32-bit Windows library directory.  This usually has a path
92           similar to
93                           "C:\WATCOM\lib386\nt"
94     - If you are using the DLL version of "freeglut", the file "freeglut.dll"
95       needs to be copied from the Debug or the Release directory into the
96       DLL directory.  This usually has a path similar to
97               "C:\Windows\System32"
98       and will probably already have the files "opengl32.dll" and "glu32.dll".
99
100
101 Unlike the *nix release, the library names are NOT automatic replacements for
102 the GLUT library names.  You may rename them manually if you wish, but this is
103 not necessary as the header file includes a pragma telling the compiler which
104 library file to look for.
105
106
107 Building and Installing the Libraries with Cygwin
108 =================================================
109
110 To build "freeglut" under Cygwin, you have two choices:
111
112 - You can build a normal Cygwin library, which depends on Cygwin's X11
113   libraries. To do this, you can just use the normal autotools incantation:
114       ./configure && make install
115
116 - Alternatively, you can build a DLL which does not depend on X11 and links
117   against the opengl32 DLL. To do this, configure need a few more flags:
118       ./configure CPPFLAGS=-mno-cygwin LDFLAGS=-mno-cygwin --without-x && make install
119
120
121 If you don't have MSVC, Open Watcom or Cygwin
122 =============================================
123
124 The "freeglut" developers' community discussed the possibility of distributing
125 binaries and decided against it.  If you need Windows library files, please
126 contact John F. Fay at <john.fay@eglin.af.mil> or put a request on the
127 "freeglut" developers' mailing list <freeglut-developer@lists.sourceforge.net>.
128