mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-29 15:44:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source 
[ci skip]
This commit is contained in:
Camilla Berglund 2016-07-14 18:19:46 +02:00
parent 2bea621f7d
commit c1b1e0aab1
2 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -35,14 +35,13 @@ binaries](http://www.glfw.org/download.html) available for all supported
compilers. compilers.
See the [compilation guide](http://www.glfw.org/docs/latest/compile.html) in the 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 ## Using GLFW
See the [building application guide](http://www.glfw.org/docs/latest/build.html) 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 guide in the documentation for more information.
programs using GLFW.
## System requirements ## System requirements
@ -54,8 +53,7 @@ Experimental implementations for the Wayland protocol and the Mir display
server are available but not yet officially supported. server are available but not yet officially supported.
See the [compatibility guide](http://www.glfw.org/docs/latest/compat.html) See the [compatibility guide](http://www.glfw.org/docs/latest/compat.html)
in the documentation for more information on various platform-specific APIs and in the documentation for more information.
extensions.
## Reporting bugs ## Reporting bugs

2
docs/compat.dox
View File

@ -185,7 +185,7 @@ a non-default value will cause @ref glfwCreateWindow to fail and the
@section compat_vulkan Vulkan loader and API @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 This should be installed by graphics drivers and Vulkan SDKs. If this is not
available, @ref glfwVulkanSupported will return `GLFW_FALSE` and all other available, @ref glfwVulkanSupported will return `GLFW_FALSE` and all other
Vulkan-related functions will fail with an @ref GLFW_API_UNAVAILABLE error. Vulkan-related functions will fail with an @ref GLFW_API_UNAVAILABLE error.