implemented SUPER key/modifier support on windows
[freeglut] / README
1 BRIEF OVERVIEW
2 ==============
3
4 This is the freeglut package.
5
6 Freeglut, the Free OpenGL Utility Toolkit, is meant to be a free alternative to
7 Mark Kilgard's GLUT library. Freeglut is free software, distributed under an
8 MIT/X11 style license. You are free to use, modify, and redistribute FreeGLUT
9 with or without modifications (see COPYING for details).
10
11 PORTS
12 =====
13
14 Currently supported platforms:
15  - UNIX systems with X11 and Wayland (such as GNU/Linux, FreeBSD, etc)
16  - MS Windows
17  - macOS with XQuartz (no native Cocoa support yet)
18  - Android (NDK)
19  - BlackBerry
20
21 Consult the platform-specific readme files for details on the level of support
22 and build instructions.
23
24
25 INSTALLATION
26 ============
27
28 See README.cmake as a starting point, as well as the other README
29 files for further info.
30
31
32 CONTRIBUTING
33 ============
34
35 Patches for bugfixes and new features are certainly welcome. Please send patches
36 to the freeglut-developer mailing list (see CONTACT below).
37
38 Feel free to report any bugs you encounter, using our bug tracking system:
39 https://sourceforge.net/p/freeglut/bugs/
40 Feature requests are also welcome at:
41 https://sourceforge.net/p/freeglut/feature-requests/
42
43 If your bug report needs urgent attention, please also post a message to the
44 aforementioned freeglut-developer mailing list, to make sure we'll see it ASAP.
45
46
47 CONTACT
48 =======
49
50 FreeGLUT website: http://freeglut.sourceforge.net
51
52 FreeGLUT mailing lists:
53  - developer: https://lists.sourceforge.net/lists/listinfo/freeglut-developer
54  - bugs: https://lists.sourceforge.net/lists/listinfo/freeglut-bugs
55  - announce: https://lists.sourceforge.net/lists/listinfo/freeglut-announce
56
57   You need to subscribe before posting to any of our mailing lists. Make sure
58   to avoid selecting "daily digest mode" if you intend to post, so that you can
59   reply properly to specific messages. Also, please do not top-post, and try to
60   send properly formated emails (text, hard-wrapped at 72 columns, no binary or
61   large attachements).