INSTALL.txt

Gingr is part of the Harvest suite and is normally distributed as a
dependency-free Linux binary or OS X app (see https://github.com/marbl/harvest).
This source distribution is intended for other operating systems or for
development.


Dependencies:
-------------
   - Qt4 >= 4.8 ( http://qt-project.org/downloads )
   - Harvest tools ( https://github.com/marbl/harvest-tools )
      - Autoconf ( http://www.gnu.org/software/autoconf/ )
      - Protocol Buffers ( https://code.google.com/p/protobuf/ )
      - Cap'n Proto ( https://capnproto.org/ )
      - Zlib ( http://www.zlib.net/, comes with OS X and most Linux distributions )
   - XCode ( OS X only, https://developer.apple.com/xcode/ )


Setup:
------
   ./bootstrap.sh
   ./configure [--with-harvest=...] [--with-protobuf=...] [--with-capnp=...]
   qmake

Notes: The --with-...=... options, if used, must specify absolute paths the
top-level directories of their respective installations, eg. without "/bin" or
"/lib". These options default to /usr/local, which is where each of these tools
would have installed by default when building them from source.


Building (Linux):
-----------------

Build:
   make

Product:
   gingr (executable)

Deployment:
   gingr relies on Qt libraries, which can be included statically during
Setup by calling qmake from a static Qt installation (which must be in a
separate location from any dynamic Qt installations to avoid library
ambiguities).


Building (OS X):
----------------

Build:
   [Open gingr.xcodeproj in XCode and build]

Product:
   gingr.app (location depends on XCode settings)

Deployment:
   'macdeployqt gingr.app' will bundle Qt frameworks in the App.