GLVERTEX QUICK START SHEET:

If you cannot wait to get your hands on the glVertex frame work, then
please first run the installer script on Linux and Mac (by typing
./installer.sh in the terminal). On the Mac it is assumed that XCode
has been installed before. On Windows 10 please install MinGW 7.3
64-bit (from mingw-w64.org), TortoiseSVN (from tortoisesvn.net) and
the Qt framework (Qt 5.12 LTS from download.qt.io/archive), then run
the "installer.bat" script. Also make sure that the graphics drivers
have been installed properly. After installation of the frame work,
the best way to write your own 3D graphics code is to use the Qt
programming template in the "qt_template" directory.

The programming template "qt_template.cpp" just shows an empty window
in the beginning. It is waiting for you to fill in OpenGL code in the
marked section of the renderOpenGL() method. As a starting point, it
is recommended to uncomment the code that is provided in the marked
section as a legacy-style programming example.

In order to compile the programming template, you may choose between
several options:

* QtCreator (Linux/Win): Open the "qt_template.pro" file with Qt
  Creator. Then apply the code changes in the editor pane and hit the
  green Run button to compile and start the modified program.

* CMake (Linux/Mac): Open a terminal and type "cmake . && make" in the
  code directory.

* QMake (Linux): Open a terminal and type "qmake && make" in the code
  directory.

* XCode (Mac): To create XCode project files you need to run the
  "generate.sh" script from the command line. After that you can open
  the generated project directory with XCode and build the project.

In order to run the compiled program from the terminal, type
"./qt_template" in the program directory. To quit the application
press ESC or Ctrl-q. You may also toggle the fullscreen mode by
pressing Ctrl-f.

If everything went well, you now have a program that renders a line
from the bottom-left to the top-right corner of the
window. Congratulations!

If you experience problems with your graphics hardware drivers, you
can enable the so called software rasterizer on Linux: It is slow, but
it does usually work:

> export LIBGL_ALWAYS_SOFTWARE=1

In order to create your own program, it is recommended to copy the
"qt_template.cpp" source code and the following files from the
template directory into a new directory:

* CMake:     copy qt_template.cpp CMakeLists.txt
* QMake:     copy qt_template.cpp qt_template.pro
* QtCreator: copy qt_template.cpp qt_template.pro
* XCode:     copy qt_template.cpp qt_template.pro generate.sh

If you wish to rename the program, you need to rename both the
"qt_template.cpp" and the "qt_template.pro" files.

For an overview of the programming API, see the glVertex quick
reference sheet ("QUICKREF.txt" and "QUICKREF.pdf") and the GLSLmath
documentation ("glslmath.txt"). Or have a look at the code examples in
the "qt_examples" directory.
