Moving some Windows-specific code out of "freeglut_main.c" into the Windows-specific...
[freeglut] / README
1
2     BRIEF OVERVIEW
3     ==============
4
5     This is the freeglut package.
6
7     Freeglut, the Free openGL Utility Toolkit, is meant to be a free alter-
8     native to Mark Kilgard's GLUT library. It is distributed under an X-Consor-
9     tium style license (see COPYING for details), to offer you a chance to use 
10     and/or modify the source.
11
12     It makes use of OpenGL, GLU, and pthreads-win32 libraries. The library does
13     not make use of any GLUT code and is not 100% compatible. Code recompilation
14     and/or slight modifications might be required for your applications to work
15     with freeglut.
16
17
18     PORTS
19     =====
20
21     Both X11 and Win32 ports are in an advanced alpha stage, which means that
22     they provide limited functionality of GLUT API 3. There is an investigation
23     en course to check if the BeOS port could be easily done using the current
24     freeglut structure.
25
26
27     INSTALLATION
28     ============
29
30     Use the following commands to build from scratch on a *nix X11 platform:
31
32         ./autogen.sh
33         ./configure
34         make
35
36     The first command is only needed after a fresh checkout, a source distribution
37     already contains all necessary files for the last two steps.
38
39
40     CONTRIBUTING
41     ============
42
43     Bug and missing features patches are certainly welcome. Just as comments 
44     and FREEGLUT API 1 propositions are.
45
46     Just please to make the fixes look visually just as the rest of the code 
47     does (tabs converted 4 white spaces). Comments are really welcome, as I 
48     believe it would be nice for people fresh new to OpenGL see how the things
49     are done... 
50
51
52     WEB SITE AND CONTACTING THE AUTHOR
53     ==================================
54
55     Freeglut project has moved to the SourceForge:
56     http://freeglut.sourceforge.net
57
58
59     THE HOPE
60     ========
61
62     Hope you find my work somehow useful.
63     Pawel W. Olszta, <olszta@sourceforge.net>
64
65
66     PASSING THE BATON
67     =================
68
69     In late December 2000, Pawel decided that he no longer
70     wished to maintain freeglut because he has moved out of
71     the graphics field.  I volunteered to take over from him
72     and have been running the project since Jan 13th 2001.
73
74     I'm also the author and maintainer of the PLIB library suite
75     and 'freeglut' really fits in well with that work.
76
77     I just hope I can live up to Pawel's high standards. Pawel
78     remains on the active developers list.
79
80     Steve Baker <sjbaker1@airmail.net>
81                 http://plib.sourceforge.net
82
83