Adding some instructions about building on a *nix platform to the 'README' file
[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         autoheader
33         aclocal
34         libtoolize --copy --force
35         automake --add-missing
36         autoconf
37         ./configure
38         make
39
40     The first four of these commands are automated in a system script called
41     "autoreconf".
42
43
44     CONTRIBUTING
45     ============
46
47     Bug and missing features patches are certainly welcome. Just as comments 
48     and FREEGLUT API 1 propositions are.
49
50     Just please to make the fixes look visually just as the rest of the code 
51     does (tabs converted 4 white spaces). Comments are really welcome, as I 
52     believe it would be nice for people fresh new to OpenGL see how the things
53     are done... 
54
55
56     WEB SITE AND CONTACTING THE AUTHOR
57     ==================================
58
59     Freeglut project has moved to the SourceForge:
60     http://freeglut.sourceforge.net
61
62
63     THE HOPE
64     ========
65
66     Hope you find my work somehow useful.
67     Pawel W. Olszta, <olszta@sourceforge.net>
68
69
70     PASSING THE BATON
71     =================
72
73     In late December 2000, Pawel decided that he no longer
74     wished to maintain freeglut because he has moved out of
75     the graphics field.  I volunteered to take over from him
76     and have been running the project since Jan 13th 2001.
77
78     I'm also the author and maintainer of the PLIB library suite
79     and 'freeglut' really fits in well with that work.
80
81     I just hope I can live up to Pawel's high standards. Pawel
82     remains on the active developers list.
83
84     Steve Baker <sjbaker1@airmail.net>
85                 http://plib.sourceforge.net
86
87