Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.66 KB

building.md

File metadata and controls

71 lines (50 loc) · 2.66 KB
Raw

Build Status

ThorStream

Install Instructions:

From Homebrew

brew update
brew install thors-serializer

From GitHub Header only version

    git clone --single-branch --branch header-only https://github.com/Loki-Astari/ThorsSerializer.git

This will download just the set of required header files into the directory ThorsSerializer.

You will need to add this directory to your include path.

From GitHub For Development

The basic script for installing everything is:

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

But installing everything requires a couple of extra libraries and some development tools. You may not need all these tools (try and use brew if you don't).

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.

Note: On M1 Macs this is now /opt/homebrew/include and /opt/homebrew/lib.

Note: libThorSerialize17.so is build using -O3 and thus is fully optimized and debug symbols have been stripped.
libThorSerialize17D.so is build using -g and is useful for debugging purposes. libThorsLogging17.so libThorsLogging17D.so libThorsStorage17.so libThorsStorage17D.so

Note: On mac it uses .dylib rather than .so.

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++17 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.

What is installed:

  • /usr/local/include/ThorSerialize/*
  • /usr/local/include/ThorsIOUtil/*
  • /usr/local/include/ThorsStorage/*
  • /usr/local/include/GitUtility/*
  • /usr/local/lib/libThorSerialize17.so
  • /usr/local/lib/libThorSerialize17D.so
  • /usr/local/lib/libThorsStorage17.so
  • /usr/local/lib/libThorsStorage17D.so
  • /usr/local/lib/libyaml.so
  • /usr/local/share/man/man3/*