From c1b1e0aab1435ede42770a3e10a496a034c683d5 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Thu, 14 Jul 2016 18:19:46 +0200 Subject: [PATCH] Documentation work [ci skip] --- README.md | 8 +++----- docs/compat.dox | 2 +- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c5a6484a..2d995548 100644 --- a/README.md +++ b/README.md @@ -35,14 +35,13 @@ binaries](http://www.glfw.org/download.html) available for all supported compilers. See the [compilation guide](http://www.glfw.org/docs/latest/compile.html) in the -documentation for information on compiling GLFW. +documentation for more information. ## Using GLFW See the [building application guide](http://www.glfw.org/docs/latest/build.html) -guide in the GLFW documentation for information on how to compile and link -programs using GLFW. +guide in the documentation for more information. ## System requirements @@ -54,8 +53,7 @@ Experimental implementations for the Wayland protocol and the Mir display server are available but not yet officially supported. See the [compatibility guide](http://www.glfw.org/docs/latest/compat.html) -in the documentation for more information on various platform-specific APIs and -extensions. +in the documentation for more information. ## Reporting bugs diff --git a/docs/compat.dox b/docs/compat.dox index ee10770f..175036b9 100644 --- a/docs/compat.dox +++ b/docs/compat.dox @@ -185,7 +185,7 @@ a non-default value will cause @ref glfwCreateWindow to fail and the @section compat_vulkan Vulkan loader and API -GLFW uses the standard system-wside Vulkan loader to access the Vulkan API. +GLFW uses the standard system-wide Vulkan loader to access the Vulkan API. This should be installed by graphics drivers and Vulkan SDKs. If this is not available, @ref glfwVulkanSupported will return `GLFW_FALSE` and all other Vulkan-related functions will fail with an @ref GLFW_API_UNAVAILABLE error.