document GLCXX_GL_INCLUDE macro in README

2015-10-11 16:21:57 -04:00 · 2015-10-11 16:21:57 -04:00 · 77f0a4bdc2
commit 77f0a4bdc2
parent e0f6651161
1 changed files with 3 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -39,6 +39,9 @@ with the project. The top-level `include` directory needs to be added to the
 C++ include path, and the *.cpp sources under the `src` directory need to be
 compiled and linked with the project.

+glcxx headers need access to an OpenGL header. The integrating project should
+define the macro `GLCXX_GL_INCLUDE` to a string naming the include file to use.
+
 ## License

 glcxx is licensed under the [MIT License](LICENSE).