diff --git a/README.md b/README.md index 45a395f..ed37978 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ # Magnum + Qt Quick bootstrap -This app demonstrates usage if Magnum rendering engine within a Qt Quick application. +This app demonstrates Magnum rendering engine within a Qt Quick application, using +a shared framebuffer object.. ## Common pitfalls ### Header inclusion order -Follow a simple rules: Always include Magnum's headers first. If you're including -your own headers, make sure that this rules is preserved. It's very easy to violate it. +Follow one simple rule: Always include Magnum's headers first. If you're including +your own headers, make sure that this rules is obeyed. It's very easy to violate it. Common symptom is compiler errors about missing declarations for `glFinish`, `glFlush` -and `glGetError`, which some Qt headers (`QOpenGLFunctions`) are unbdefining. +and `glGetError`, which some Qt headers (`QOpenGLFunctions`) are undefining. For a bomb-proof solution, make a header file that includes all of your Magnum and Qt dependencies in correct order.