diff --git a/docs/quick.dox b/docs/quick.dox index 34f543bb..b9ab2552 100644 --- a/docs/quick.dox +++ b/docs/quick.dox @@ -314,13 +314,19 @@ for example, many kinds of editing tools. Now that you know how to initialize GLFW, create a window and poll for keyboard input, it's possible to create a simple program. -@snippet simple.c code - This program creates a 640 by 480 windowed mode window and starts a loop that clears the screen, renders a triangle and processes events until the user either presses Escape or closes the window. -This program uses only a few of the many functions GLFW provides. There are +@snippet simple.c code + +The program above can be found in the +[source package](http://www.glfw.org/download.html) as `examples/simple.c` +and is compiled along with all other examples when you build GLFW. If you +built GLFW from the source package then already have this as `simple.exe` on +Windows, `simple` on Linux or `simple.app` on OS X. + +This tutorial used only a few of the many functions GLFW provides. There are guides for each of the areas covered by GLFW. Each guide will introduce all the functions for that category. @@ -330,15 +336,10 @@ functions for that category. - @ref monitor - @ref input +You can access reference documentation for any GLFW function by clicking it and +the reference for each function links to related functions and guide sections. -@section quick_build Compiling and linking the program - -The complete program above can be found in the source distribution as -`examples/simple.c` and is compiled along with all other examples when you -build GLFW. That is, if you have compiled GLFW then you have already built this -as `simple.exe` on Windows, `simple` on Linux or `simple.app` on OS X. - -This tutorial ends here. Once you have written a program that uses GLFW, you +The tutorial ends here. Once you have written a program that uses GLFW, you will need to compile and link it. How to do that depends on the development environment you are using and is best explained by the documentation for that environment. To learn about the details that are specific to GLFW, see