Skip to content

Latest commit

 

History

History
89 lines (77 loc) · 3.17 KB

README.md

File metadata and controls

89 lines (77 loc) · 3.17 KB

Build Status Codacy Badge CodeFactor Documentation

GL4Dummies

GL4Dummies is a C wrapper around OpenGL that aims to help C developers to easily produce Multi-platform OpenGL 3.3+ applications.

Installation

The build systemis based on autotools.

Dependencies

GL4Dummies has two dependencies: OpenGL and the SDL2. You will at least need to install the SDL development package to get GL4Dummies running. You can install it with your favorite package manager if you have access to one. Here are some common names for the package you will need for the SDL:

  • libsdl2-dev on Linux distros based on Debian (including Ubuntu)
  • sdl2 on distros based on Arch Linux
  • SDL2-devel on Void Linux
  • sdl2-dev on Alpine Linux
  • libsdl2 with MacPorts on macOS
  • sdl2 with HomeBrew on macOS

GNU Autotools

In order to launch autotools config, type make -f Makefile.autotools. The following packages are required:

  • pkg-config (pkgconfig under macOS)
  • automake
  • autoconf
  • libtool
  • make

You can then run the following command:

make -f Makefile.autotools

With superuser rights

If you have superuser rights and wish to install globally GL4Dummies, you can run the following commands:

./configure
make # you can also run `make -j` for parallel compilation
sudo make install

You will then need to edit your .profile, .bash_profile, .zprofile or your .bashrc and add the following line:

export PATH=/usr/local/bin:$PATH
export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH

Or, if you use fish, edit your ~/.config/fish/config.fish file and add the following line:

set -gx LD_LIBRARY_PATH /usr/local/lib $LD_LIBRARY_PATH

Without superuser rights

If you do not have superuser rights on your machine, or if you want to install GL4Dummies locally, you can run the following instead:

[ -d $HOME/local ] || mkdir $HOME/local
./configure --prefix=$HOME/local
make
make install

You will then need to add to your .profile, .bash_profile, .zprofile or .bashrc the following lines:

export PATH=$HOME/local/bin:$PATH
export LD_LIBRARY_PATH=$HOME/local/lib:$LD_LIBRARY_PATH

And if you use fish, you will instead need to add the following lines to your ~/.config/fish/config.fish file:

set -gx PATH $HOME/local/bin $PATH
set -gx LD_LIBRARY_PATH $HOME/local/lib $LD_LIBRARY_PATH

Online instructions

You can also refer to the manual (PDF) for more in-depth instructions (in French).

Under the Windows Operating System, please use Visual Studio (Community 2019) or CodeBlocks files in the Windows directory.