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