1/*!
2
3@mainpage notitle
4
5@section main_intro Introduction
6
7GLFW is a free, Open Source, multi-platform library for OpenGL, OpenGL ES and
8Vulkan application development.  It provides a simple, platform-independent API
9for creating windows, contexts and surfaces, reading input, handling events, etc.
10
11See @ref news_33 for highlights or the
12[version history](http://www.glfw.org/changelog.html) for details.
13
14@ref quick_guide is a guide for users new to GLFW.  It takes you through how to
15write a small but complete program.
16
17There are guides for each section of the API:
18
19 - @ref intro_guide – initialization, error handling and high-level design
20 - @ref window_guide – creating and working with windows and framebuffers
21 - @ref context_guide – working with OpenGL and OpenGL ES contexts
22 - @ref vulkan_guide - working with Vulkan objects and extensions
23 - @ref monitor_guide – enumerating and working with monitors and video modes
24 - @ref input_guide – receiving events, polling and processing input
25
26Once you have written a program, see @ref compile_guide and @ref build_guide.
27
28The [reference documentation](modules.html) provides more detailed information
29about specific functions.
30
31@ref moving_guide explains what has changed and how to update existing code to
32use the new API.
33
34There is a section on @ref guarantees_limitations for pointer lifetimes,
35reentrancy, thread safety, event order and backward and forward compatibility.
36
37The [FAQ](http://www.glfw.org/faq.html) answers many common questions about the
38design, implementation and use of GLFW.
39
40Finally, @ref compat_guide explains what APIs, standards and protocols GLFW uses
41and what happens when they are not present on a given machine.
42
43This documentation was generated with Doxygen.  The sources for it are available
44in both the [source distribution](http://www.glfw.org/download.html) and
45[GitHub repository](https://github.com/glfw/glfw).
46
47*/
48