diff --git a/docs/build.dox b/docs/build.dox index aa6c5fe80..b9bd904c9 100644 --- a/docs/build.dox +++ b/docs/build.dox @@ -182,6 +182,9 @@ CMake files look for OpenGL. target_link_libraries(myapp glfw ${OPENGL_glu_LIBRARY} ${GLFW_LIBRARIES}) @endcode +@warning Don't define `GLFW_INCLUDE_NONE` before `add_subdirectory(path/to/glfw)` +in your `CMakeLists.txt` file, otherwise you will encounter build errors. + @subsection build_link_cmake_pkgconfig With CMake on Unix and installed GLFW binaries diff --git a/docs/compile.dox b/docs/compile.dox index 11d3798c6..aeaed5610 100644 --- a/docs/compile.dox +++ b/docs/compile.dox @@ -240,6 +240,10 @@ High Performance Graphics Rendering on Optimus Systems_ for more details. context creation API. Note that EGL is not yet provided on all supported platforms. +@note Define these options before `add_subdirectory(path/to/glfw)` to make them +effective in your `CMakeLists.txt` file in case you are building your project +@ref build_link_cmake_source. + @section compile_manual Compiling GLFW manually