implemented SUPER key/modifier support on windows

[freeglut] / README.cmake

diff --git a/README.cmake b/README.cmake
index 51ab817..4b3962d 100644 (file)
--- a/README.cmake
+++ b/README.cmake
@@ -1,4 +1,5 @@
-How to build freeglut with CMake:\r
+How to build freeglut with CMake on Windows (MS Visual Studio)\r
+--------------------------------------------------------------\r
 1.  Download CMake (http://www.cmake.org/cmake/resources/software.html).\r
     Get one of the releases from the binary distribution section.\r
 2.  Run the CMake installer, install wherever you like. \r
@@ -28,6 +29,52 @@ Open the freeglut.sln file that was generated in your build directory,
 and compile as usual\r
 \r
 \r
+How to build freeglut on UNIX\r
+-----------------------------\r
+- Make sure you have cmake installed. Examples:\r
+  - Debian/Ubuntu: apt-get install cmake\r
+  - Fedora: yum install cmake\r
+  - FreeBSD: cd /usr/ports/devel/cmake && make install\r
+  Or directly from their website:\r
+  http://www.cmake.org/cmake/resources/software.html\r
+- Make sure you have the basics for compiling code, such as C compiler\r
+  (e.g., GCC) and the make package.\r
+- Also make sure you have packages installed that provide the relevant\r
+  header files for opengl (e.g., libgl1-mesa-dev on Debian/Ubuntu) and\r
+  the chosen backend :\r
+  - X11: x11 (e.g., libx11-dev, libxrandr-devel on Debian/Ubuntu) and\r
+  XInput (libxi-dev / libXi-devel)\r
+  - Wayland: wayland (e.g., libwayland-dev and libegl1-mesa-dev on\r
+  Debian/Ubuntu) and xkbcommon (libxkbcommon-dev /libxkbcommon-devel)\r
+- Run 'cmake .' (or 'cmake . -DFREEGLUT_WAYLAND=ON' for Wayland) in the\r
+  freeglut directory to generate the makefile.\r
+- Run 'make' to build, and 'make install' to install freeglut.\r
+- If you wish to change any build options run 'ccmake .'\r
 \r
-Breakdown of CMake configuration options:\r
-TODO\r
+\r
+Breakdown of CMake configuration options\r
+----------------------------------------\r
+CMAKE_BUILD_TYPE            [Empty, Debug, Release] Can be overriden by\r
+                            passing it as a make variable during build.\r
+CMAKE_INSTALL_PREFIX       Installation prefix (e.g. /usr/local on UNIX)\r
+FREEGLUT_BUILD_DEMOS       [ON, OFF] Controls whether the demos are\r
+                            built or not.\r
+FREEGLUT_BUILD_SHARED_LIBS  [ON, OFF] Build freeglut as a shared library\r
+FREEGLUT_BUILD_STATIC_LIBS  [ON, OFF] Build freeglut as a static library\r
+FREEGLUT_GLES               [ON, OFF] Link with GLEs libraries instead\r
+                            of OpenGL\r
+FREEGLUT_WAYLAND            [ON, OFF] Link with Wayland libraries instead\r
+                            of X11\r
+FREEGLUT_PRINT_ERRORS       [ON, OFF] Controls whether errors are\r
+                            default handled or not when user does not\r
+                            provide an error callback\r
+FREEGLUT_PRINT_WARNINGS     [ON, OFF] Controls whether warnings are\r
+                            default handled or not when user does not\r
+                            provide an warning callback\r
+FREEGLUT_REPLACE_GLUT       [ON, OFF] For non-Windows platforms,\r
+                            freeglut is by default built as -lglut. if\r
+                            off, built as -lfreeglut. On Windows,\r
+                            libraries are always built as freeglut.\r
+INSTALL_PDB                 [ON, OFF] MSVC only: controls whether debug\r
+                            information files are included with the\r
+                            install or not\r