Permalink
Fetching contributors…
Cannot retrieve contributors at this time
49 lines (36 sloc) 2.31 KB

Build Status

ThorStream

Building Instructions:

    > git clone git@github.com:Loki-Astari/ThorsSerializer.git
    > cd ThorsSerializer
    > ./configure --disable-binary
    > make
    > sudo make install

Description

By default installation will be in /usr/local/include and /usr/local/lib. You can override this with the normal auto-tools defaults. Use ./configure --help to get details.

What is installed:

  • /usr/local/include/ThorSerialize/*
  • /usr/local/include/ThorBinaryRep/*
  • /usr/local/lib/libThorSerialize14.so
  • /usr/local/lib/libThorSerialize14D.so

Note: libThorSerialize14.so is build using -O3 and thus is fully optimized and debug symbols have been stripped.
libThorSerialize14D.so is build using -g and is useful for debugging purposes.

What is Downloaded

The configuration processes will download the generic makefiles (using git) from ThorMaker which in turn will download and build google's gtest and vera++ library that is used in running the unit tests.

Requirements

This library uses features from C++14 so you will need a compiler that supports this. The generic makefile also does code coverage tests so your compiler will also need to support a code coverage tool that has an interface similar to gcov.

It has been tested on travis-ci.org using clang 3.5 and g++ 4.9 (on mac and ubuntu). Though clang 3.4 also supports C++14 its code coverage tool is very basic and the generic makefiles will fail when attempting to perform code coverage tests.

The yaml serialization uses libyaml so you will need that installed locally. The configuration files attempt to detect in the default location. If it is not there detailed instructions of your options are provided.

Configuration Flags

You can disable some of the serialization code with:

    --disable-yaml
    --disable-binary

Note: Because the binary serialization is still experimental I force you to explicitly turn in on with:

    --with-thors-network-byte-order