From 5499fd307a6a57349a374f147023ad2f45c0171f Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Sun, 31 Jan 2016 20:22:53 +0100 Subject: [PATCH] Contribution guide work --- CONTRIBUTING.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a73c65e0..fbe09669 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,10 @@ clock_gettime /dev/js XI Xf86vm`), as described ### Reporting a compile or link bug +__Note:__ GLFW needs many system APIs to do its job. See the [Building +applications](http://www.glfw.org/docs/latest/build.html) guide for more +information. + In addition to the information above, always include the complete build log from your compiler and linker. Issue posts are editable so it can always be shortened later. @@ -32,9 +36,15 @@ shortened later. __Note:__ Windows ships with graphics drivers that do not support OpenGL. If GLFW says that your machine lacks support for OpenGL, it very likely does. +Install drivers from the computer manufacturer or graphics card manufacturer +([Nvidia](http://www.geforce.com/drivers), + [AMD](http://support.amd.com/en-us/download), + [Intel](https://www-ssl.intel.com/content/www/us/en/support/detect.html)) to +fix this. -__Note:__ AMD only supports OpenGL ES on Windows via EGL, which is not enabled -in GLFW by default. You need to enable EGL when compiling GLFW to use this. +__Note:__ AMD only supports OpenGL ES on Windows via EGL. EGL support is not +enabled in GLFW by default. You need to [enable EGL when +compiling](http://www.glfw.org/docs/latest/compile.html) GLFW to use this. The `glfwinfo` tool is included in the GLFW source tree as `tests/glfwinfo.c` and is built along with the library. It lets you request any kind of context @@ -53,6 +63,10 @@ __Note:__ On headless systems on some platforms, no monitors are reported. This causes glfwGetPrimaryMonitor to return `NULL`, which not all applications are prepared for. +__Note:__ Some third-party tools report more video modes than those approved of +by the OS. For safety and compatbility, GLFW only reports video modes the OS +wants programs to use. This is not a bug. + The `monitors` tool is included in the GLFW source tree as `tests/monitors.c` and is built along with the library. lists all information about connected monitors made available by GLFW.