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