X-Git-Url: http://git.mutantstargoat.com/user/nuclear/?a=blobdiff_plain;f=README.cmake;h=4b3962d845ec380d8e579ac9d70485ea1e4d12df;hb=HEAD;hp=9d4bfac5675f3bb6659e29a1f80d391a6717b89f;hpb=151cec6ef6d821bbb0a61f9482386359ca956ce2;p=freeglut

diff --git a/README.cmake b/README.cmake
index 9d4bfac..4b3962d 100644
--- a/README.cmake
+++ b/README.cmake
@@ -37,19 +37,44 @@ How to build freeglut on UNIX
   - FreeBSD: cd /usr/ports/devel/cmake && make install
   Or directly from their website:
   http://www.cmake.org/cmake/resources/software.html
-- Install XInput: libxi-dev / libXi-devel
-- Run 'cmake .' in the freeglut directory to generate the makefile.
+- Make sure you have the basics for compiling code, such as C compiler
+  (e.g., GCC) and the make package.
+- Also make sure you have packages installed that provide the relevant
+  header files for opengl (e.g., libgl1-mesa-dev on Debian/Ubuntu) and
+  the chosen backend :
+  - X11: x11 (e.g., libx11-dev, libxrandr-devel on Debian/Ubuntu) and
+  XInput (libxi-dev / libXi-devel)
+  - Wayland: wayland (e.g., libwayland-dev and libegl1-mesa-dev on
+  Debian/Ubuntu) and xkbcommon (libxkbcommon-dev /libxkbcommon-devel)
+- Run 'cmake .' (or 'cmake . -DFREEGLUT_WAYLAND=ON' for Wayland) in the
+  freeglut directory to generate the makefile.
 - Run 'make' to build, and 'make install' to install freeglut.
 - If you wish to change any build options run 'ccmake .'
 
 
 Breakdown of CMake configuration options
 ----------------------------------------
-BUILD_SHARED_LIBS       [ON, OFF] Build freeglut as a shared library
-BUILD_STATIC_LIBS       [ON, OFF] Build freeglut as a static library
-CMAKE_BUILD_TYPE        [Empty, Debug, Release] Can be overriden by passing it
-                        as a make variable during build.
-CMAKE_INSTALL_PREFIX	Installation prefix (e.g. /usr/local on UNIX)
-FREEGLUT_BUILD_DEMOS	[ON, OFF] Controls whether the demos are built or not.
-FREEGLUT_GLES1          [ON, OFF] TODO
-FREEGLUT_GLES2          [ON, OFF] TODO
+CMAKE_BUILD_TYPE            [Empty, Debug, Release] Can be overriden by
+                            passing it as a make variable during build.
+CMAKE_INSTALL_PREFIX	    Installation prefix (e.g. /usr/local on UNIX)
+FREEGLUT_BUILD_DEMOS	    [ON, OFF] Controls whether the demos are
+                            built or not.
+FREEGLUT_BUILD_SHARED_LIBS  [ON, OFF] Build freeglut as a shared library
+FREEGLUT_BUILD_STATIC_LIBS  [ON, OFF] Build freeglut as a static library
+FREEGLUT_GLES               [ON, OFF] Link with GLEs libraries instead
+                            of OpenGL
+FREEGLUT_WAYLAND            [ON, OFF] Link with Wayland libraries instead
+                            of X11
+FREEGLUT_PRINT_ERRORS       [ON, OFF] Controls whether errors are
+                            default handled or not when user does not
+                            provide an error callback
+FREEGLUT_PRINT_WARNINGS     [ON, OFF] Controls whether warnings are
+                            default handled or not when user does not
+                            provide an warning callback
+FREEGLUT_REPLACE_GLUT       [ON, OFF] For non-Windows platforms,
+                            freeglut is by default built as -lglut. if
+                            off, built as -lfreeglut. On Windows,
+                            libraries are always built as freeglut.
+INSTALL_PDB                 [ON, OFF] MSVC only: controls whether debug
+                            information files are included with the
+                            install or not