Building the software

Linux (Ubuntu flavor) 64bits is actually the main development platform. Building on 32 bits target should be possible without any problems. Windows build support has been dropped, due to priorities, but some earlier versions have been build for Windows, so it should be possible.

The whole build process is base on GNU make, thus it needs to be available on the target machine. There is actually no autoconf neither Cmake-type build provided.

Simple build and installing

Once you have installed the source tree, either through an archive file or by using subversion, build is very simple. To build and install the software an a standard Debian or Ubuntu machine, just use this:

   make
   sudo make install-bin

The minimal requirements for this default build target are as follows:

• a C++11 capable compiler (from release 0.5.1, GCC 4.8 requested)
• boost libraries (not included):
  • property_tree (used for reading ini configuration files)
  • file_system
  • preprocessor

If required, all of the boost stuff should be made available on a Debian-based machine with the following command:

sudo apt-get install build-essential libboost-dev-all

Alternatively, you can also use make install, but this requires the manual to be build, as the doc target is a prerequisite of the install target (see below). So it would actually be better to do this:

   make doc -j
   sudo make install

The latter line will actually call the install script, that itself will copy:

• binary files in /usr/local/bin
• configuration files (css) in /etc/gensched/

Additional targets

For a list of available targets and options, just try make help.

If you need to build the user manual, type make doc. Be aware that this target requires that the following software is installed on local machine:

• ditaa (0.9), great ascii-art rendering tool, see http://ditaa.sourceforge.net/.
• scrot (0.8), see http://en.wikipedia.org/wiki/Scrot
• imagemagick (6.6.9)
• wkhtmltopdf (0.12.1), see http://wkhtmltopdf.org/
• pdftk (1.44),
• and, of course, doxygen (1.8.5).

On a Ubuntu 14.04, these dependencies can be installed with the following command:

sudo apt-get ditaa scrot imagemagick wkhtmltopdf pdftk doxygen

Note

The version numbers above are there just for reference, doesn't mean previous/latest versions will fail.

Warning

This target attempts to read css style sheets from the local machine, so the software must be installed (see above).

This target also calls the target demo, that (re)builds the samples from sources. If you only have doxygen installed, the command make dox will only build the manual, without the additionnal image processing stuff.

Alternatively, if one of the requirements above is not fullfilled you can use the full documentation provided in binary package.

If you want/need to build the full documentation of source files, replace doc by doc-dev in the previous command.

Notes on Windows build (for the volunteer...)

The previous Windows binary has been build on Windows 8 using gcc 4.9.2 from Mingw-w64 (http://mingw-w64.sourceforge.net/)

At present, only the binary release is uploaded (does not include demos and documentation). The release is statically linked with standard library to avoid runtime issues if Mingw runtime libraries not installed on local machine. Windows makefile has only a few targets that are functional at present but this should be improved in the future.