CMake OpenGL application template using GLFW, Glew and glm.
The template uses submodules for its main libraries.
So to clone the repository, use the following command:
$ git clone --recursive https://github.com/vscav/GL-app-template.git
Alternatively, if you don't used the --recursive option, you can later run:
$ git submodule init
$ git submodule update
You can build the project on linux by using command lines only. In order to do that, you will have to follow some steps.
First, Update package database:
$ sudo apt update
And install the updates identified previously:
$ sudo apt upgrade
Then, install g++ (a C++ compiler):
$ sudo apt install g++
Finally, install CMake:
$ sudo apt install cmake
In the apllication directory, create the build folder and move into it:
$ mkdir build && cd build
Build and compile the template:
$ cmake .. && make -j
Run the executable by using this pattern:
$ ./app
The template uses Doxygen as its main documentation generator for its engine. If you have previously installed Doxygen, run the following command:
$ make doc
The documentation can be found in build/doc/doc. It is generated as html and LaTeX files.
The template can be build on Windows and Mac OSX by using CLion, a C/C++ IDE.
Open CLion and go to File/Open. Then, in the search window, select the template directory containing the CMake file.
CLion will detect that the opened project is a CMake project and will generate and build the files.
Then, you just need to check that the app executable is selected in the dropdown menu at the top and run it by clicking on the play button.
To generate the documentation, select the docs executable in the dropdown list and as well run it by clicking on the play button.
Coming soon.
Coming soon.
Coming soon.
- OpenGL - OpenGL documentation
- GLFW - GLFW documentation
- Doxygen - Doxygen documentation
- CMake - CMake documentation
- CLion - Download CLion IDE
- Visual Studio 2019 - Download Visual Studio 2019 IDE
- Visual Studio Code - Download Visual Studio Code