Skip to content

Joker Installation

Jack edited this page Sep 22, 2020 · 17 revisions

[Wiki under construction: to be updated & improved]

Joker is uploaded to git with the necessary source files to be compiled as a standalone program as well as a static library

Pre-compiled Binaries

Although building Joker from source on your own system is recommended, pre-compiled binaries for your system may be available on the Releases page.

Compiling from source

Joker can be compiled from source using cmake, download the latest tagged code from the main repo page

From within the joker project file, run the following commands in terminal:

mkdir Build

cd Build

cmake ..

make

This will produce a 'jk' executable within the Build folder which can be ran with ./jk from within /Build.

make install - this may require sudo

This will install the joker libraries and executable to /usr/local. Joker can now be invoked with jk in terminal.

Use Joker in another C++ Project

The above installation instructions will install the joker library and header files into /usr/local/lib and /usr/local/include/joker.

in your C++ project point you compiler and linker to the above directories and use the following within your code:

#include "joker.h"

The following shared libraries will also need to be linked (linker flags shown in brackets):

  • jpeg (-ljpeg)
  • pthread (-lpthread)
Clone this wiki locally