Usage

To use the clockwork libraries, you have to:

Build from source

Requirements

Our complete toolchain uses cmake to configure the projects for every plattform. You download the package on Linux or from the cmake homepage on Windows. Also you need a C++11 compiler. On Linux we support gcc4.7+ and clang3+, on Windows Visual Studio 2013. Other compilers might work, but aren't tested.

Download source archive

The current source packages can always be found on the Downloads page of general. The name normally should be general-<version>-src.zip. Just download and extract it where you like to.

Building library

Linux

Building for Linux isn't that difficult. After you extracted the source package, move to this directory using your bash.
If there is a directory called deps or dependencies this library has external dependencies. Some of them are necessary for every configuration, some aren't. Most of them can also be downloaded using you're packet manager. But for those you don't have or you want to build on your own, just call the related build script from within the directory it is located:

./build-<dep>.sh

Then type these commands from the root directory of the archive:

cmake .

make

make install

This will build the default configuration of general. You can see all project dependent cmake variables in the documentation of general. Also you can set the directory where to install the results using the cmake variable CMAKE_INSTALL_PREFIX.

Windows

Building for Windows isn't that difficult. After you extracted the source package, you should check whether there are some dependencies you need. If so, start the x86 native tools of the Visual Studio environment (normally located in a directory like "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\") and move to the dependency directory. For easy use there normally is a build-dependencies.bat which will build all required dependencies automatically. You type

build-dependencies.bat

After this you can move back to the root directory of the archive. The next step is to run cmake. You can do this on commandline if installed

cmake .

or you configure it using cmake-gui. After the generation you'll find a Visual Studio Solution file (.sln) in your binary directory (the directory of the extracted archive if you used . or selected the same in cmake-gui). You can double-click to open it in Visual Studio or build it on commandline with native tools typing

MSBuild.exe <somename>.sln

MSBuild.exe INSTALL.vcxproj

This will Now you have built the default configuration of general. You can see all project dependent cmake variables in the documentation of general. Also you can set the directory where to install the results using the cmake variable CMAKE_INSTALL_PREFIX.

Download prebuilt packages

Arch Linux

You can obtain the software <package> from the AUR archiv using your prefered method. Note: we offer packages only in the new AUR4. E.g. if you use yaourt, use the follow command to install:
yaourt --aur-url https://aur4.archlinux.org -S <package>

.deb based systems

Using a debian repository (e.g. for Debian, Mint and Ubuntu) you have to follow these steps. You just have to type them into your bash.
  1. Add the repository to your sources.list (do this as super user because you need write permissions on sources.list)
  2. echo "deb http://packages.clockwork-origins.de/deb/ stable main" >> /etc/apt/sources.list

  3. Get the public GPG key to authenticate our packages
  4. wget -O - http://packages.clockwork-origins.de/deb/contact@clockwork-origins.de.gpg.key | sudo apt-key add -

  5. Now you can simply download packages from our repository using
  6. sudo apt-get update

    Install the libraries

    sudo apt-get install <package>-libs

    Install the header

    sudo apt-get install <package>-devel

.rpm based systems

Using a rpm repository (e.g. for openSUSE, Fedora and CentOS) you have to follow these steps. You just have to type them into your bash.
  1. Download the repository file
  2. wget -O - http://packages.clockwork-origins.de/clockwork.repo > clockwork.repo

  3. Add the repository
    • yum based systems

    • You should have a directory /etc/yum.repos.d/ where you should put the clockwork.repo file. You need super user rights to write to this directory.

      sudo mv clockwork.repo /etc/yum.repos.d/

    • yast based systems

    • If you're using e.g. openSUSE you have a software manager to download packages. To add the repository, you use zypper on the command line.

      sudo zypper ar -r clockwork.repo

      You can delete the file now.
  4. Now you can simply download packages from our repository using
    • yum based systems
    • sudo yum update

      Install the libraries

      sudo yum install <package>-libs

      Install the header

      sudo yum install <package>-devel

    • yast based systems

    • Open the yast software manager and enter the package name you want to download. At first you will be informed that there is a new gpg key you should trust if you want to use our packages.

Windows

For Windows we currently offer prebuilt packages for Visual Studio 2013. The name scheme is <package>-<version>-<MSVC version>-<architecture (x86/x64)>. Included in the archive are all binaries and includes necessary to start directly with programming. Includes can be found in the include folder, dlls and executables in bin folder and import libraries and static libraries in the lib folder. There might more directories, but they are project dependent.