From 8c4ce9a3de195d09dd2e65c4e58caca5c5dc63ee Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Mon, 8 Feb 2016 16:23:44 +0100 Subject: [PATCH] Documentation work [ci skip] --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57b1b721..26f92a92 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,8 @@ GLFW itself needs only the headers and libraries for your window system. It does not need the headers for any context creation API (WGL, GLX, EGL, NSGL) or rendering API (OpenGL, OpenGL ES, Vulkan) to enable support for them. -GLFW bundles a number of dependencies in the `deps/` directory. These are only -used by the tests and examples and are not required to build the library. +The examples and test programs depend on a number of tiny libraries. These are +located in the `deps/` directory. - [getopt\_port](https://github.com/kimgr/getopt_port/) for examples with command-line options @@ -68,6 +68,9 @@ used by the tests and examples and are not required to build the library. The Vulkan example additionally requires the Vulkan SDK to be installed, or it will not be included in the build. +The documentation is generated with [Doxygen](http://doxygen.org/). If CMake +does not find Doxygen, the documentation will not be generated. + ## Changelog