OpenGL Template

Boilerplate for OpenGL applications

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Additional documentation

Getting Started

To set up the project, follow the steps below.

Clone the repository

git clone https://github.com/CGS-IITKGP/OpenGL-template.git --recurse-submodules

Update submodule using

git submodule update --init --recursive

Prerequisites

The following dependencies are required to be installed for the project to function properly:

• CMake

  • Linux (Ubuntu/Debian-based) Install using package managers or from their CMake GitHub page.

     sudo apt update
     sudo apt install cmake

  • macOS

    Install using Homebrew or from their CMake GitHub page.

     brew install cmake

  • Windows Install using the installer or from their CMake GitHub page.

    1. Download the installer from the CMake website.
    2. Follow the installation steps. Alternatively, you can install it via winget: winget install cmake

(back to top)

Installation

The environment has now been set up and configured to properly compile and run the project.

Run cmake to compile and run the project

cmake .

The compiled binary is saved in ./build To clean the build directory, run

rm -rf build/

Note: The latest version of OpenGL is 4.6 but we are using 4.1 for the sake of macOS compatibility. Click here to upgrade to the later version

(back to top)

Additional documentation

• License
• DeepWiki
• CONTRIBUTING

This repo was forked from dhanvithnayak/OpenGL-template

(back to top)