Benutzung

Um die Clockwork-Bibliotheken zu benutzen, musst du:

Vom Quellcode bauen

Voraussetzungen

Unsere komplette Toolchain nutzt CMake, um die Projekte für jede Plattform zu konfigurieren. Lade unter Linux das Package oder von der CMake Homepage unter Windows. Außerdem brauchst du einen C++11 Compiler. Unter Linux unterstützen wir gcc4.7+ und clang3+, unter Windows Visual Studio 2013. Andere Compiler können ebenfalls funktionieren, wurden aber nicht getestet.

Download des Source-Archivs

Das aktuelle Source-Archiv findest du immer auf der Downloadseite von general. Der Name ist normalerweise general-<version>-src.zip. Lade es einfach herunter und entpacke es wohin du willst.

Bibliothek bauen

Linux

Für Linux zu bauen ist nicht allzu schwer. Nachdem du das Source-Archiv entpackt hast, gehe mit der Bash in das Verzeichnis.
Falls es dort ein Verzeichnis mit Namen deps oder dependencies gibt, dann hat diese Bibliothek externe Abhängigkeiten. Manche von ihnen sind für jede Konfiguration wichtig, andere nicht. Die meisten kannst du mit deinem Paketmanager herunterladen. Aber für die, die du nicht hast oder selber bauen willst, kannst du einfach das entsprechende Build-Skript innerhalb des Ordners aufrufen, in dem es liegt:

./build-<dep>.sh

Danach tippe diese Kommandos vom Hauptverzeichnis des Ordners des entpackten Archivs:

cmake .

make

make install

Das wird die Standardkonfiguration von general bauen. Eine Liste aller projektspezifischen CMake-Variablen kannst du in der Dokumentation von general einsen. Außerdem kannst du das Zielverzeichnis, wo die Ergebnisse installiert werden sollen, mit der CMake-Variable CMAKE_INSTALL_PREFIX setzen.

Windows

Für Windows zu bauen ist nicht allzu schwer. Nachdem du das Source-Archiv entpackt hast, solltest du überprüfen ob das Projekt Abhängigkeiten hat, die du brauchst. Wenn dem so ist, dann starte die x86 Native Tools für die Visual Studio Umgebung (normalerweise in einem Ordner wie "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\" zu finden) und wechsle auf der Konsole ins dependencies-Verzeichnis. Zum einfachen Gebrauch gibt es normalerweise eine build-dependencies.bat, die alle benötigten Abhängigkeiten automatisch baut. Tippe dazu

build-dependencies.bat

Anschließend wechsle zurück ins Hauptverzeichnis des entpackten Archivs. Der nächste Schritt ist der Aufruf von CMake. Du kannst das über die Kommandozeile erledigen, wenn du es installiert hast

cmake .

oder du konfigurierst es mit der CMake-GUI. Nach der Generierung findest du ein Visual Studio Solution File (.sln) im gewählten Binary-Ordner (der Ordner des entpackten Archivs, falls du . auf der Kommandozeile benutzt hast oder in der GUI den selber Ordner gewählt hast). Du kannst es mit einem Doppelklick in Visual Studio öffnen oder wieder mit den Native Tools auf der Kommandozeile bauen, indem du folgendes eintippst:

MSBuild.exe <somename>.sln

MSBuild.exe INSTALL.vcxproj

Das wird die Standardkonfiguration von general bauen. Eine Liste aller projektspezifischen CMake-Variablen kannst du in der Dokumentation von general einsen. Außerdem kannst du das Zielverzeichnis, wo die Ergebnisse installiert werden sollen, mit der CMake-Variable CMAKE_INSTALL_PREFIX setzen.

Prebuilt-Packages downloaden

Arch Linux

Du kannst die Software <package> aus dem AUR-Archiv mit der Methode deiner Wahl installieren. Hinweis: Wir bieten unsere Pakete nur im neuen AUR4 an. Wenn du z.B. yaourt verwendest, nutze folgenden Befehl zum installieren:
yaourt --aur-url https://aur4.archlinux.org -S <package>

.deb basierte Systeme

Um ein debian-Repository (z.B. für Debian, Mint und Ubuntu) zu nutzen musst du die folgenden Schritte befolgen. Du musst diese in die bash eintippen.
  1. Hinzufügen des Repositories zu deiner sources.list (mach das als Super User, weil du Schreibrechte auf sources.list brauchst)
  2. echo "deb http://packages.clockwork-origins.de/deb/ stable main" >> /etc/apt/sources.list

  3. Hole dir den öffentlichen GPG-Key, um unsere Pakete zu authentifizieren
  4. wget -O - http://packages.clockwork-origins.de/deb/contact@clockwork-origins.de.gpg.key | sudo apt-key add -

  5. Jetzt kannst du ganz einfach Packages aus unserem Repository runterladen, indem du
  6. sudo apt-get update

    Bibliotheken installieren

    sudo apt-get install <package>-libs

    Header installieren

    sudo apt-get install <package>-devel

.rpm basierte Systeme

Um ein rpm-Repository (z.B. für openSUSE, Fedora und CentOS) zu nutzen musst du die folgenden Schritte befolgen. Du musst diese in die bash eintippen.
  1. Repository-File runterladen
  2. wget -O - http://packages.clockwork-origins.de/clockwork.repo > clockwork.repo

  3. Repository hinzufügen
    • yum/dnf basierte Systeme

    • Du solltest ein Verzeichnis /etc/yum.repos.d/ haben, wo du die Datei clockwork.repo ablegen solltest. Du brauchst Superuser-Rechte, um in dieses Verzeichnis zu schreiben.

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

    • yast basierte Systeme

    • Falls du z.B. openSUSE benutzt, hast du einen Software Manager zum Downloaden von Packages. Um das Repository hinzuzufügen, benutzt du zypper auf der Kommandozeile.

      sudo zypper ar -r clockwork.repo

      Du kannst die Datei jetzt wieder löschen.
  4. Jetzt kannst du ganz einfach Packages aus unserem Repository runterladen, indem du
    • yum basierte Systeme
    • sudo yum update

      Bibliotheken installieren

      sudo yum install <package>-libs

      Header installieren

      sudo yum install <package>-devel

    • yast basierte Systeme

    • Öffne den yast-Software Manager und gibt den Package-Namen, den du herunterladen willst, ein. Zuerst wirst du informiert, dass ein neuer GPG-Key gefunden wurde, dem du trauen solltest, falls du unsere Packages laden willst.

Windows

Für Windows bieten wir zur Zeit prebuilt Packages für Visual Studio 2013 an. Das Namensschema ist <package>-<version>-<MSVC version>-<architecture (x86/x64)>. Im Archiv enthalten sind alle Binaries und Header, die benötigt werden, um direkt loslegen zu können. Includes sind im include-Ordner, dll's und Executables im bin-Ordner und Import-Bibliotheken und statische Bibliotheken im lib-Ordner. Es gibt möglicherweise noch mehr Ordner, aber diese sind dann projektspezifisch.