Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-29 13:32:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source
This commit is contained in:
Camilla Löwy 2017-07-12 00:21:17 +02:00
parent 8e899ccc29
commit 67c9155f3b
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -36,10 +36,10 @@ fixes live in [other branches](https://github.com/glfw/glfw/branches/all) until
they are stable enough to merge. they are stable enough to merge.
If you are new to GLFW, you may find the If you are new to GLFW, you may find the
[tutorial](http://www.glfw.org/docs/latest/quick.html) for GLFW [tutorial](http://www.glfw.org/docs/latest/quick.html) for GLFW 3 useful. If
3 useful. If you have used GLFW 2 in the past, there is a you have used GLFW 2 in the past, there is a [transition
[transition guide](http://www.glfw.org/docs/latest/moving.html) for moving to guide](http://www.glfw.org/docs/latest/moving.html) for moving to the GLFW
the GLFW 3 API. 3 API.
## Compiling GLFW ## Compiling GLFW
@ -53,12 +53,11 @@ MinGW-w64, on macOS with Clang and on Linux and other Unix-like systems with GCC
and Clang. It will likely compile in other environments as well, but this is and Clang. It will likely compile in other environments as well, but this is
not regularly tested. not regularly tested.
There are also [pre-compiled Windows There are [pre-compiled Windows binaries](http://www.glfw.org/download.html)
binaries](http://www.glfw.org/download.html) available for all compilers available for all supported compilers.
supported on that platform.
See the [compilation guide](http://www.glfw.org/docs/latest/compile.html) for See the [compilation guide](http://www.glfw.org/docs/latest/compile.html) for
more information about how to compile GLFW. more information about how to compile GLFW yourself.
## Using GLFW ## Using GLFW
@ -108,12 +107,11 @@ located in the `deps/` directory.
- [Vulkan headers](https://www.khronos.org/registry/vulkan/) for Vulkan tests - [Vulkan headers](https://www.khronos.org/registry/vulkan/) for Vulkan tests
The Vulkan example additionally requires the Vulkan SDK to be installed, or it The Vulkan example additionally requires the Vulkan SDK to be installed, or it
will not be included in the build. On macOS you need to will not be included in the build. On macOS you need to provide the path to the
[provide the path](@ref vulkan_loader) to the MoltenVK SDK manually as it has no MoltenVK SDK manually as it has no standard installation location.
standard installation location.
The documentation is generated with [Doxygen](http://doxygen.org/). If CMake The documentation is generated with [Doxygen](http://doxygen.org/) if CMake can
does not find Doxygen, the documentation will not be generated when you build. find that tool.
## Reporting bugs ## Reporting bugs