_______________________________________
PyOpenGL Readme 2001-01-06

PyOpenGL is a cross-platform open source 
Python binding to the standard OpenGL API 
providing 2-D and 3-D graphic drawing. 
PyOpenGL supports the GL, GLU, and GLUT 
libraries.  The library can be used with 
the Tkinter, wxPython, FxPy, and Win32GUI 
windowing libraries (or almost any Python 
windowing library which can provide an 
OpenGL context).

PyOpenGL's Official Homepage is:
    http://pyopengl.sourceforge.net/

_______________________________________
Interfaces to Other Libraries

PyOpenGL currently requires either:
    Python 1.5.2 or
    Python 2.0
because of the use of the distutils
setup mechanisms.  For versions of
Python earlier than 1.5.2, the PyOpenGL
1.5.5 release (available from the PyOpenGL
project download page) may be usable.

PyOpenGL includes support the TOGL widget 
for the Tkinter GUI.  This package is 
available at:
    http://www.ssec.wisc.edu/~brianp/Togl.html
Togl 1.5b3 is currently shipped with PyOpenGL.

PyOpenGL's setup will attempt to enable certain
functionality (primarily array support) if it 
can import the Python Numeric Extensions available 
at:
    http://numpy.sourceforge.net
Most people interested in using PyOpenGL for
nontrivial purposes will want to install this 
package before installing PyOpenGL.

PyOpenGL does not directly interface with 
the Python Imaging Library (PIL), but PIL
images can be used within PyOpenGL easily.
Demonstrations of this are available within
the PyOpenGL package. PIL is available at:
    http://www.pythonware.com/products/pil/index.htm


_______________________________________
Installation (Binary)

Executable installers are available for Win32 systems.

_______________________________________
Installation (Source)

You need Distutils 0.9.1 or higher, Python
2.0 users should already have this installed,
see:
	http://www.python.org/sigs/distutils-sig/download.html
for Python 1.5.2 support.

1) Run: "python setup.py build" (optional, install includes build)
2) Run: "python setup.py install"
(for more parameters to setup.py see the distutils documentation
or try "python setup.py <cmd> --help" )    

Notes:
    On Win32 you can specify another compiler by running
    "python setup.py build build_ext --compiler=????"
    ("python setup.py build_ext --help-compiler" should show all
    possible values for the compiler option)
    
    It was tested with following compilers (Win32)
    VC++ 6.0, MinGW32/gcc2.95, BCC 5.5 (and LCC-Win32)
    
    LCC-Win32 can't compile wgl, it is a C-compiler (no C++). And it 
    is currently not supported by distutils. (If someone wants to 
    use LCC-Win32 with distutils write an email to R.Liebscher@gmx.de)
    
    The setup will try to build Togl if the Tkinter module can be 
    imported.  Togl version 1.5b3 is the version shipped with this 
    version of PyOpenGl.

    When Togl is built, the shared library (Togl.so) will be placed into 
    the directory OpenGL/Tk/{sys.platform + "-tk" + tk_version}

    (Togl can also be built into tkappinit.c, but that's usually not 
    worth it if your machine supports shared libraries.)

_______________________________________
Bug reports:

Send bug reports to: pyopengl@eGroups.com
(see also the mailing list archive at
http://www.egroups.com/group/PyOpenGL/)

Before you send any bug reports, try the demos 
and if they show the same problem send a problem 
description for the demo.

Always include:
- complete traceback
- version of PyOpenGL, Python and other packages
as appropriate (Numeric,PIL)

If you have problems compiling PyOpenGL, also include:
- description of your system and your compiler
- output of following python statements

  import os,sys
  print os.uname()
  print sys.platform
