X-Git-Url: http://git.mutantstargoat.com/user/nuclear/?a=blobdiff_plain;f=README;h=3eddc79362d42c2b08cb32445291a7b6d6692edf;hb=66baf810dcc4db19723a2d622b49b1dfb6815047;hp=268201e02360fc876f619398f69c77aa62e86f70;hpb=c90e3f21e02020232054f78029ef9071c7359cfb;p=freeglut diff --git a/README b/README index 268201e..3eddc79 100644 --- a/README +++ b/README @@ -2,60 +2,57 @@ BRIEF OVERVIEW ============== - This is an alpha release of the freeglut package. Currently only - the alpha version of freeglut-1.3 library is available. - + This is the freeglut package. + Freeglut, the Free openGL Utility Toolkit, is meant to be a free alter- native to Mark Kilgard's GLUT library. It is distributed under an X-Consor- tium style license (see COPYING for details), to offer you a chance to use and/or modify the source. - - It makes use of OpenGL, GLU, GLib and pthreads-win32 libraries. GLib is - LGPL'ed and I hope I do not violate it's license by using it. In case this - is true, please notify me so that I remove GLib usage from the project. - - The library does not make use of any GLUT code and is not 100% compatible. - Code recompilation and/or slight modifications might be required for your - applications to work with freeglut. - + + It makes use of OpenGL, GLU, and pthreads-win32 libraries. The library does + not make use of any GLUT code and is not 100% compatible. Code recompilation + and/or slight modifications might be required for your applications to work + with freeglut. + PORTS ===== Both X11 and Win32 ports are in an advanced alpha stage, which means that - they provide limited functionality of GLUT API 3. There is an investigation - en course to check if the BeOS port could be easily done using the current - freeglut structure. + they provide limited functionality of GLUT API 3. A somewhat more + limited port (mostly due to limits of the OS) to Andriod is now also + available. INSTALLATION ============ - See the INSTALL file. - - + See README.cmake as a starting point, as well as the other README + files for further info. + + CONTRIBUTING ============ - + Bug and missing features patches are certainly welcome. Just as comments - and FREEGLUT API 1 propositions are. + and FREEGLUT API propositions are. Just please to make the fixes look visually just as the rest of the code does (tabs converted 4 white spaces). Comments are really welcome, as I believe it would be nice for people fresh new to OpenGL see how the things are done... - - + + WEB SITE AND CONTACTING THE AUTHOR ================================== Freeglut project has moved to the SourceForge: http://freeglut.sourceforge.net - - + + THE HOPE ======== - + Hope you find my work somehow useful. Pawel W. Olszta,