This readme file applies to the git clone of FreeGLUT's svn repo on sourceforge.net that is hosted on github. This is provided here to enable user to contribute easier.
Every effort is made to ensure that the git_master branch only progresses in a fastforward manner, but complete guarantees cannot be given as the sourceforge.net trunk is at all times leading.
I will be unable to merge a pull request if the github clone is behind svn/trunk on sourceforge.net. Should you detect this, please contact me, maybe through making an issue here on github.
This copy of the svn repository was not created with git svn but with the excellent svn support of SmartGit.
Notes to self on how to work with this: Basic workflow upon receiving a pull request is as follows:
- Merge pull request on github
- pull in changes to my local clone of the
git_masterbranch. - cherry pick the merged commits onto my local clone of the
svn/trunkbranch - push these commits to svn remote (this alters the commits in the local
svn/trunkclone as extra meta data is added) - merge
svn/trunkinto localgit_master - push merge commit to github (its fast forward!)
Freeglut, the Free OpenGL Utility Toolkit, is meant to be a free alternative to Mark Kilgard's GLUT library. Freeglut is free software, distributed under an MIT/X11 style license. You are free to use, modify, and redistribute freeglut with or without modifications (see COPYING for details).
In short, freeglut can be used by OpenGL programs to perform those tasks which would normally require platform-specific code. Tasks like creating a window, creating an OpenGL context and binding it to the window, and processing input events. Freeglut provides a concise and elegant API to handle those tasks, in a platform-independent manner, keeping the application simple and portable.
One of the main goals of freeglut, is maximum compatibility. Freeglut is both source and binary-compatible with the original GLUT, and can be used as a drop-in replacement for it. We take great care to maintain a stable API and ABI, and to introduce any new features and improvements in a way which does not compromise compatibility.
Freeglut can be used with a wide range of OpenGL implementations, from the very early OpenGL 1.0 on SGI computers, to the very latest modern OpenGL versions on current GPUs. It can be used to create a classic OpenGL context, or a versioned core profile or compatibility context. Freeglut can also be used with OpenGL ES, on desktop or mobile devices.
Currently supported platforms:
- UNIX systems with X11 or Wayland (such as GNU/Linux, FreeBSD, IRIX, etc)
- MS Windows
- Android (NDK)
- BlackBerry
Consult the platform-specific readme files for details on the level of support and build instructions.
Freeglut relies on cmake (minimum 3.0.0) to generate build files for all the different supported platforms and toolchains.
See README.cmake as a starting point, as well as the other README
files for further info.
For those cases where using cmake is inconvenient, we also provide a set of
unofficial, unsupported, possibly unmaintained, but potentially useful,
alternative build files. See altbuild/README.md for details.
Patches and pull requests for bugfixes and new features are certainly welcome. Please send patches to the freeglut-developer mailing list (see CONTACT below).
Feel free to report any bugs you encounter, using the github issues system.
Older bug reports and feature requests are still reachable on:
But you are encouraged to use github issues for new ones.
Alternatively you can also send bug reports and feature requests to the freeglut-developer mailing list if you prefer. Extended discussions about new features and design issues for large contributions, are best suited to the mailing list.
FreeGLUT website: http://freeglut.sourceforge.net
FreeGLUT mailing lists:
- developer: https://lists.sourceforge.net/lists/listinfo/freeglut-developer
- bugs: https://lists.sourceforge.net/lists/listinfo/freeglut-bugs
- announce: https://lists.sourceforge.net/lists/listinfo/freeglut-announce
You need to subscribe before posting to any of our mailing lists. Make sure to avoid selecting "daily digest mode" if you intend to post, so that you can reply properly to specific messages. Also, please do not top-post, and try to send properly formated emails (text, hard-wrapped at 72 columns, no binary or large attachements).