Mention Wayland build requirements in documentation

[freeglut] / README.cmake

diff --git a/README.cmake b/README.cmake
index ffd387e..4b3962d 100644 (file)
--- a/README.cmake
+++ b/README.cmake
@@ -40,10 +40,14 @@ How to build freeglut on UNIX
 - 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 x11 (including xrandr) and opengl (e.g.,\r
-  libgl1-mesa-dev, libx11-dev and libxrandr-dev on Debian/Ubuntu).\r
-- Install XInput: libxi-dev / libXi-devel\r
-- Run 'cmake .' in the freeglut directory to generate the makefile.\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
@@ -59,6 +63,8 @@ FREEGLUT_BUILD_SHARED_LIBS  [ON, OFF] Build freeglut as a shared library
 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